1 /*
2 * Copyright (c) 2009, 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
31 * and reports their replacement text unprocessed (if
32 * available). This event will be reported if javax.xml.stream.isReplacingEntityReferences
33 * is set to false. If javax.xml.stream.isReplacingEntityReferences is set to true
34 * entity references will be resolved transparently.
35 *
36 * Entities are handled in two possible ways:
37 *
38 * (1) If javax.xml.stream.isReplacingEntityReferences is set to true
39 * all entity references are resolved and reported as markup transparently.
40 * (2) If javax.xml.stream.isReplacingEntityReferences is set to false
41 * Entity references are reported as an EntityReference Event.
42 *
43 * @version 1.0
44 * @author Copyright (c) 2009 by Oracle Corporation. All Rights Reserved.
45 * @since 1.6
46 */
47 public interface EntityReference extends XMLEvent {
48
49 /**
50 * Return the declaration of this entity.
51 */
52 EntityDeclaration getDeclaration();
53
54 /**
55 * The name of the entity
56 * @return the entity's name, may not be null
57 */
58 String getName();
59 }
|
1 /*
2 * Copyright (c) 2009, 2020, 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
31 * and reports their replacement text unprocessed (if
32 * available). This event will be reported if javax.xml.stream.isReplacingEntityReferences
33 * is set to false. If javax.xml.stream.isReplacingEntityReferences is set to true
34 * entity references will be resolved transparently.
35 *
36 * Entities are handled in two possible ways:
37 *
38 * (1) If javax.xml.stream.isReplacingEntityReferences is set to true
39 * all entity references are resolved and reported as markup transparently.
40 * (2) If javax.xml.stream.isReplacingEntityReferences is set to false
41 * Entity references are reported as an EntityReference Event.
42 *
43 * @version 1.0
44 * @author Copyright (c) 2009 by Oracle Corporation. All Rights Reserved.
45 * @since 1.6
46 */
47 public interface EntityReference extends XMLEvent {
48
49 /**
50 * Return the declaration of this entity.
51 * @return the declaration
52 */
53 EntityDeclaration getDeclaration();
54
55 /**
56 * The name of the entity
57 * @return the entity's name, may not be null
58 */
59 String getName();
60 }
|