/*
 * Copyright Amherst College
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package edu.amherst.acdc.trellis.spi;

import java.util.Map;

/**
 * Namespaces may be stored globally across the repository, and the NamespaceService
 * provides a mechanism for retrieving and setting namespace values.
 *
 * @author acoburn
 */
public interface NamespaceService {

    /**
     * Fetch the entire namespace mapping
     * @return the namespace mapping
     */
    Map<String, String> getNamespaces();

    /**
     * Fetch the namespace for a particular prefix
     * @param prefix the prefix
     * @return the corresponding namespace
     */
    String getNamespace(String prefix);

    /**
     * Set the namespace for a given prefix
     * @param prefix the prefix
     * @param namespace the namespace
     */
    void setNamespace(String prefix, String namespace);

}

/*
 * Copyright Amherst College
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package edu.amherst.acdc.trellis.spi;

import java.util.Map;
import java.util.Optional;

/**
 * Namespaces may be stored globally across the repository, and the NamespaceService
 * provides a mechanism for retrieving and setting namespace values.
 *
 * @author acoburn
 */
public interface NamespaceService {

    /**
     * Fetch the entire namespace mapping
     * @return the namespace mapping as prefix, namespace pairs
     */
    Map<String, String> getNamespaces();

    /**
     * Fetch the namespace for a particular prefix
     * @param prefix the prefix
     * @return the corresponding namespace
     */
    Optional<String> getNamespace(String prefix);

    /**
     * Fetch the prefix for a particular namespace
     * @param namespace the namespace
     * @return the corresponding prefix
     */
    Optional<String> getPrefix(String namespace);

    /**
     * Set the namespace for a given prefix
     * @param prefix the prefix
     * @param namespace the namespace
     * @return whether the new prefix was set
     */
    Boolean setPrefix(String prefix, String namespace);

}

update NS service API