View Javadoc

1   /*
2    * ModeShape (http://www.modeshape.org)
3    * See the COPYRIGHT.txt file distributed with this work for information
4    * regarding copyright ownership.  Some portions may be licensed
5    * to Red Hat, Inc. under one or more contributor license agreements.
6   * See the AUTHORS.txt file in the distribution for a full listing of 
7   * individual contributors.
8    *
9    * ModeShape is free software. Unless otherwise indicated, all code in ModeShape
10   * is licensed to you under the terms of the GNU Lesser General Public License as
11   * published by the Free Software Foundation; either version 2.1 of
12   * the License, or (at your option) any later version.
13   *
14   * ModeShape is distributed in the hope that it will be useful,
15   * but WITHOUT ANY WARRANTY; without even the implied warranty of
16   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17   * Lesser General Public License for more details.
18   *
19   * You should have received a copy of the GNU Lesser General Public
20   * License along with this software; if not, write to the Free
21   * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
22   * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
23   */
24  package org.modeshape.graph.property;
25  
26  import net.jcip.annotations.ThreadSafe;
27  import org.modeshape.common.text.TextDecoder;
28  
29  /**
30   * A factory for creating {@link Name names}.
31   */
32  @ThreadSafe
33  public interface NameFactory extends ValueFactory<Name> {
34  
35      /**
36       * Create a name from the given namespace URI and local name.
37       * <p>
38       * This method is equivalent to calling {@link #create(String, String, TextDecoder)} with a null encoder.
39       * </p>
40       * 
41       * @param namespaceUri the namespace URI
42       * @param localName the local name
43       * @return the new name
44       * @throws IllegalArgumentException if the local name is <code>null</code> or empty
45       */
46      Name create( String namespaceUri,
47                   String localName );
48  
49      /**
50       * Create a name from the given namespace URI and local name.
51       * 
52       * @param namespaceUri the namespace URI
53       * @param localName the local name
54       * @param decoder the decoder that should be used to decode the qualified name
55       * @return the new name
56       * @throws IllegalArgumentException if the local name is <code>null</code> or empty
57       */
58      Name create( String namespaceUri,
59                   String localName,
60                   TextDecoder decoder );
61  
62      /**
63       * Get the namespace registry.
64       * 
65       * @return the namespace registry; never <code>null</code>
66       */
67      NamespaceRegistry getNamespaceRegistry();
68  }