1 /*

     2  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

     3  *

     4  * This code is free software; you can redistribute it and/or modify it

     5  * under the terms of the GNU General Public License version 2 only, as

     6  * published by the Free Software Foundation.  Oracle designates this

     7  * particular file as subject to the "Classpath" exception as provided

     8  * by Oracle in the LICENSE file that accompanied this code.

     9  *

    10  * This code is distributed in the hope that it will be useful, but WITHOUT

    11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

    12  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

    13  * version 2 for more details (a copy is included in the LICENSE file that

    14  * accompanied this code).

    15  *

    16  * You should have received a copy of the GNU General Public License version

    17  * 2 along with this work; if not, write to the Free Software Foundation,

    18  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

    19  *

    20  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

    21  * or visit www.oracle.com if you need additional information or have any

    22  * questions.

    23  */

    24 

    25 /*

    26  * Copyright (c) 2009 by Oracle Corporation. All Rights Reserved.

    27  */

    28 

    29 package javax.xml.stream.events;

    30 /**

    31  * An interface for handling Entity Declarations

    32  *

    33  * This interface is used to record and report unparsed entity declarations.

    34  *

    35  * @version 1.0

    36  * @author Copyright (c) 2009 by Oracle Corporation. All Rights Reserved.

    37  * @since 1.6

    38  */

    39 public interface EntityDeclaration extends XMLEvent {

    40 

    41   /**

    42    * The entity's public identifier, or null if none was given

    43    * @return the public ID for this declaration or null

    44    */

    45   String getPublicId();

    46 

    47   /**

    48    * The entity's system identifier.

    49    * @return the system ID for this declaration or null

    50    */

    51   String getSystemId();

    52 

    53   /**

    54    * The entity's name

    55    * @return the name, may not be null

    56    */

    57   String getName();

    58 

    59   /**

    60    * The name of the associated notation.

    61    * @return the notation name

    62    */

    63   String getNotationName();

    64 

    65   /**

    66    * The replacement text of the entity.

    67    * This method will only return non-null

    68    * if this is an internal entity.

    69    * @return null or the replacment text

    70    */

    71   String getReplacementText();

    72 

    73   /**

    74    * Get the base URI for this reference

    75    * or null if this information is not available

    76    * @return the base URI or null

    77    */

    78   String getBaseURI();

    79 

    80 }