81 lines
2.3 KiB
Java
81 lines
2.3 KiB
Java
/*
|
|
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
|
*
|
|
* This code is free software; you can redistribute it and/or modify it
|
|
* under the terms of the GNU General Public License version 2 only, as
|
|
* published by the Free Software Foundation. Oracle designates this
|
|
* particular file as subject to the "Classpath" exception as provided
|
|
* by Oracle in the LICENSE file that accompanied this code.
|
|
*
|
|
* This code is distributed in the hope that it will be useful, but WITHOUT
|
|
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
* version 2 for more details (a copy is included in the LICENSE file that
|
|
* accompanied this code).
|
|
*
|
|
* You should have received a copy of the GNU General Public License version
|
|
* 2 along with this work; if not, write to the Free Software Foundation,
|
|
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
*
|
|
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
|
|
* or visit www.oracle.com if you need additional information or have any
|
|
* questions.
|
|
*/
|
|
|
|
/*
|
|
* Copyright (c) 2009 by Oracle Corporation. All Rights Reserved.
|
|
*/
|
|
|
|
package javax.xml.stream.events;
|
|
/**
|
|
* An interface for handling Entity Declarations
|
|
*
|
|
* This interface is used to record and report unparsed entity declarations.
|
|
*
|
|
* @version 1.0
|
|
* @author Copyright (c) 2009 by Oracle Corporation. All Rights Reserved.
|
|
* @since 1.6
|
|
*/
|
|
public interface EntityDeclaration extends XMLEvent {
|
|
|
|
/**
|
|
* The entity's public identifier, or null if none was given
|
|
* @return the public ID for this declaration or null
|
|
*/
|
|
String getPublicId();
|
|
|
|
/**
|
|
* The entity's system identifier.
|
|
* @return the system ID for this declaration or null
|
|
*/
|
|
String getSystemId();
|
|
|
|
/**
|
|
* The entity's name
|
|
* @return the name, may not be null
|
|
*/
|
|
String getName();
|
|
|
|
/**
|
|
* The name of the associated notation.
|
|
* @return the notation name
|
|
*/
|
|
String getNotationName();
|
|
|
|
/**
|
|
* The replacement text of the entity.
|
|
* This method will only return non-null
|
|
* if this is an internal entity.
|
|
* @return null or the replacment text
|
|
*/
|
|
String getReplacementText();
|
|
|
|
/**
|
|
* Get the base URI for this reference
|
|
* or null if this information is not available
|
|
* @return the base URI or null
|
|
*/
|
|
String getBaseURI();
|
|
|
|
}
|