001/**
002 * #-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=#
003 *   This file is part of the LDP4j Project:
004 *     http://www.ldp4j.org/
005 *
006 *   Center for Open Middleware
007 *     http://www.centeropenmiddleware.com/
008 * #-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=#
009 *   Copyright (C) 2014 Center for Open Middleware.
010 * #-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=#
011 *   Licensed under the Apache License, Version 2.0 (the "License");
012 *   you may not use this file except in compliance with the License.
013 *   You may obtain a copy of the License at
014 *
015 *             http://www.apache.org/licenses/LICENSE-2.0
016 *
017 *   Unless required by applicable law or agreed to in writing, software
018 *   distributed under the License is distributed on an "AS IS" BASIS,
019 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
020 *   See the License for the specific language governing permissions and
021 *   limitations under the License.
022 * #-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=#
023 *   Artifact    : org.ldp4j.framework:ldp4j-application-api:0.1.0
024 *   Bundle      : ldp4j-application-api-0.1.0.jar
025 * #-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=#
026 */
027package org.ldp4j.application.ext;
028
029import java.util.List;
030import java.util.Set;
031
032/**
033 * Interface for read only Namespace processing. <br/>
034 *
035 * A Namespace has the properties: <br/>
036 *
037 * <ul>
038 * <li><b>Namespace URI</b>: Namespace name expressed as a URI to which the
039 * prefix is bound.</li>
040 * <li><b>Prefix</b></li>
041 * </ul>
042 *
043 *<br/>
044 *
045 * Note that a Namespace URI can be bound to multiple prefixes. However a prefix
046 * can only be bound to a single Namespace URI.
047 */
048public interface Namespaces {
049
050  /**
051   * Get the declared prefixes.
052   *
053   * @return the collection of defined prefixes.
054   */
055  Set<String> getDeclaredPrefixes();
056
057  /**
058   * Get Namespace URI bound to a prefix.
059   *
060   * @param prefix
061   *            prefix to look up
062   * @return Namespace URI bound to prefix
063   * @throws NullPointerException
064   *             when the prefix is {@code null}
065   */
066  String getNamespaceURI(String prefix);
067
068  /**
069   * Get prefix bound to Namespace URI.
070   *
071   * @param namespaceURI
072   *            URI of the Namespace to look up
073   * @return Prefix bound to the Namespace URI
074   * @throws NullPointerException
075   *             when the prefix is {@code null}
076   */
077  String getPrefix(String namespaceURI);
078
079  /**
080   * Get prefixes bound to Namespace URI.
081   *
082   * @param namespaceURI
083   *            URI of the Namespace to look up
084   * @return All the prefixes bound to the Namespace URI
085   * @throws NullPointerException
086   *             when the prefix is {@code null}
087   */
088  List<String> getPrefixes(String namespaceURI);
089
090}