286N/A/*
286N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
286N/A *
286N/A * This code is free software; you can redistribute it and/or modify it
286N/A * under the terms of the GNU General Public License version 2 only, as
286N/A * published by the Free Software Foundation. Oracle designates this
286N/A * particular file as subject to the "Classpath" exception as provided
286N/A * by Oracle in the LICENSE file that accompanied this code.
286N/A *
286N/A * This code is distributed in the hope that it will be useful, but WITHOUT
286N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
286N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
286N/A * version 2 for more details (a copy is included in the LICENSE file that
286N/A * accompanied this code).
286N/A *
286N/A * You should have received a copy of the GNU General Public License version
286N/A * 2 along with this work; if not, write to the Free Software Foundation,
286N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
286N/A *
286N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
286N/A * or visit www.oracle.com if you need additional information or have any
286N/A * questions.
286N/A */
286N/A
286N/A/*
286N/A * Copyright (c) 2009 by Oracle Corporation. All Rights Reserved.
286N/A */
286N/A
286N/Apackage javax.xml.stream.events;
286N/A/**
286N/A * An interface for handling Entity events.
286N/A *
286N/A * This event reports entities that have not been resolved
286N/A * and reports their replacement text unprocessed (if
286N/A * available). This event will be reported if javax.xml.stream.isReplacingEntityReferences
286N/A * is set to false. If javax.xml.stream.isReplacingEntityReferences is set to true
286N/A * entity references will be resolved transparently.
286N/A *
286N/A * Entities are handled in two possible ways:
286N/A *
286N/A * (1) If javax.xml.stream.isReplacingEntityReferences is set to true
286N/A * all entity references are resolved and reported as markup transparently.
286N/A * (2) If javax.xml.stream.isReplacingEntityReferences is set to false
286N/A * Entity references are reported as an EntityReference Event.
286N/A *
286N/A * @version 1.0
286N/A * @author Copyright (c) 2009 by Oracle Corporation. All Rights Reserved.
286N/A * @since 1.6
286N/A */
286N/Apublic interface EntityReference extends XMLEvent {
286N/A
286N/A /**
286N/A * Return the declaration of this entity.
286N/A */
286N/A EntityDeclaration getDeclaration();
286N/A
286N/A /**
286N/A * The name of the entity
286N/A * @return the entity's name, may not be null
286N/A */
286N/A String getName();
286N/A}