View Javadoc
1   /*
2    * Copyright (c) 1999, 2004, Oracle and/or its affiliates. All rights reserved.
3    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4    *
5    * This code is free software; you can redistribute it and/or modify it
6    * under the terms of the GNU General Public License version 2 only, as
7    * published by the Free Software Foundation.  Oracle designates this
8    * particular file as subject to the "Classpath" exception as provided
9    * by Oracle in the LICENSE file that accompanied this code.
10   *
11   * This code is distributed in the hope that it will be useful, but WITHOUT
12   * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13   * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14   * version 2 for more details (a copy is included in the LICENSE file that
15   * accompanied this code).
16   *
17   * You should have received a copy of the GNU General Public License version
18   * 2 along with this work; if not, write to the Free Software Foundation,
19   * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20   *
21   * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22   * or visit www.oracle.com if you need additional information or have any
23   * questions.
24   */
25  
26  package javax.naming;
27  
28  /**
29    * This interface is used for parsing names from a hierarchical
30    * namespace.  The NameParser contains knowledge of the syntactic
31    * information (like left-to-right orientation, name separator, etc.)
32    * needed to parse names.
33    *
34    * The equals() method, when used to compare two NameParsers, returns
35    * true if and only if they serve the same namespace.
36    *
37    * @author Rosanna Lee
38    * @author Scott Seligman
39    *
40    * @see CompoundName
41    * @see Name
42    * @since 1.3
43    */
44  
45  public interface NameParser {
46          /**
47            * Parses a name into its components.
48            *
49            * @param name The non-null string name to parse.
50            * @return A non-null parsed form of the name using the naming convention
51            * of this parser.
52            * @exception InvalidNameException If name does not conform to
53            *     syntax defined for the namespace.
54            * @exception NamingException If a naming exception was encountered.
55            */
56          Name parse(String name) throws NamingException;
57  }