001    /*
002     * JBoss DNA (http://www.jboss.org/dna)
003     * See the COPYRIGHT.txt file distributed with this work for information
004     * regarding copyright ownership.  Some portions may be licensed
005     * to Red Hat, Inc. under one or more contributor license agreements.
006    * See the AUTHORS.txt file in the distribution for a full listing of 
007    * individual contributors.
008     *
009     * JBoss DNA is free software. Unless otherwise indicated, all code in JBoss DNA
010     * is licensed to you under the terms of the GNU Lesser General Public License as
011     * published by the Free Software Foundation; either version 2.1 of
012     * the License, or (at your option) any later version.
013     *
014     * JBoss DNA is distributed in the hope that it will be useful,
015     * but WITHOUT ANY WARRANTY; without even the implied warranty of
016     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
017     * Lesser General Public License for more details.
018     *
019     * You should have received a copy of the GNU Lesser General Public
020     * License along with this software; if not, write to the Free
021     * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
022     * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
023     */
024    package org.jboss.dna.graph.property;
025    
026    import org.jboss.dna.common.text.TextDecoder;
027    
028    /**
029     * A factory for creating {@link Name names}.
030     * 
031     * @author Randall Hauch
032     */
033    public interface NameFactory extends ValueFactory<Name> {
034    
035        /**
036         * Create a name from the given namespace URI and local name.
037         * <p>
038         * This method is equivalent to calling {@link #create(String, String, TextDecoder)} with a null encoder.
039         * </p>
040         * 
041         * @param namespaceUri the namespace URI
042         * @param localName the local name
043         * @return the new name
044         * @throws IllegalArgumentException if the local name is <code>null</code> or empty
045         */
046        Name create( String namespaceUri,
047                     String localName );
048    
049        /**
050         * Create a name from the given namespace URI and local name.
051         * 
052         * @param namespaceUri the namespace URI
053         * @param localName the local name
054         * @param decoder the decoder that should be used to decode the qualified name
055         * @return the new name
056         * @throws IllegalArgumentException if the local name is <code>null</code> or empty
057         */
058        Name create( String namespaceUri,
059                     String localName,
060                     TextDecoder decoder );
061    
062        /**
063         * Get the namespace registry.
064         * 
065         * @return the namespace registry; never <code>null</code>
066         */
067        NamespaceRegistry getNamespaceRegistry();
068    }