001    /*
002     * JBoss, Home of Professional Open Source.
003     * Copyright 2008, Red Hat Middleware LLC, and individual contributors
004     * as indicated by the @author tags. See the copyright.txt file in the
005     * distribution for a full listing of individual contributors.
006     *
007     * This is free software; you can redistribute it and/or modify it
008     * under the terms of the GNU Lesser General Public License as
009     * published by the Free Software Foundation; either version 2.1 of
010     * the License, or (at your option) any later version.
011     *
012     * This software is distributed in the hope that it will be useful,
013     * but WITHOUT ANY WARRANTY; without even the implied warranty of
014     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015     * Lesser General Public License for more details.
016     *
017     * You should have received a copy of the GNU Lesser General Public
018     * License along with this software; if not, write to the Free
019     * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
020     * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
021     */
022    package org.jboss.dna.graph.properties;
023    
024    import org.jboss.dna.common.text.TextDecoder;
025    
026    /**
027     * A factory for creating {@link Name names}.
028     * 
029     * @author Randall Hauch
030     */
031    public interface NameFactory extends ValueFactory<Name> {
032    
033        String JCR_PRIMARY_TYPE = "jcr:primaryType";
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, String localName );
047    
048        /**
049         * Create a name from the given namespace URI and local name.
050         * 
051         * @param namespaceUri the namespace URI
052         * @param localName the local name
053         * @param decoder the decoder that should be used to decode the qualified name
054         * @return the new name
055         * @throws IllegalArgumentException if the local name is <code>null</code> or empty
056         */
057        Name create( String namespaceUri, String localName, TextDecoder decoder );
058    
059        /**
060         * Get the namespace registry.
061         * 
062         * @return the namespace registry; never <code>null</code>
063         */
064        NamespaceRegistry getNamespaceRegistry();
065    }