1 /* Copyright 2004 The Apache Software Foundation
2 *
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
6 *
7 * http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15
16 package org.apache.xmlbeans;
17
18 import javax.xml.stream.XMLStreamReader;
19
20
21 import java.util.List;
22
23
24 /**
25 * Corresponds to the XML Schema
26 * <a target="_blank" href="http://www.w3.org/TR/xmlschema-2/#ENTITIES">xs:ENTITIES</a> type,
27 * a list type.
28 * <p>
29 * A list type.
30 */
31 public interface XmlENTITIES extends XmlAnySimpleType
32 {
33 /** The constant {@link SchemaType} object representing this schema type. */
34 public static final SchemaType type = XmlBeans.getBuiltinTypeSystem().typeForHandle("_BI_ENTITIES");
35
36 /** Returns the value as a {@link List} of {@link String} values */
37 List getListValue();
38 /** Returns the value as a {@link List} of {@link XmlENTITY} values **/
39 List xgetListValue();
40 /** Sets the value as a {@link List} */
41 void setListValue(List l);
42
43 /**
44 * Returns the value as a {@link List} of {@link String} values
45 * @deprecated replaced by {@link #getListValue}
46 **/
47 List listValue();
48 /**
49 * Returns the value as a {@link List} of {@link XmlENTITY} values
50 * @deprecated replaced by {@link #getListValue}
51 **/
52 List xlistValue();
53 /**
54 * Sets the value as a {@link List}
55 * @deprecated replaced by {@link #getListValue}
56 **/
57 void set(List l);
58
59 /**
60 * A class with methods for creating instances
61 * of {@link XmlENTITIES}.
62 */
63 public static final class Factory
64 {
65 /** Creates an empty instance of {@link XmlENTITIES} */
66 public static XmlENTITIES newInstance() {
67 return (XmlENTITIES) XmlBeans.getContextTypeLoader().newInstance( type, null ); }
68
69 /** Creates an empty instance of {@link XmlENTITIES} */
70 public static XmlENTITIES newInstance(org.apache.xmlbeans.XmlOptions options) {
71 return (XmlENTITIES) XmlBeans.getContextTypeLoader().newInstance( type, options ); }
72
73 /** Creates an immutable {@link XmlENTITIES} value */
74 public static XmlENTITIES newValue(Object obj) {
75 return (XmlENTITIES) type.newValue( obj ); }
76
77 /** Parses a {@link XmlENTITIES} fragment from a String. */
78 public static XmlENTITIES parse(java.lang.String s) throws org.apache.xmlbeans.XmlException {
79 return (XmlENTITIES) XmlBeans.getContextTypeLoader().parse( s, type, null ); }
80
81 /** Parses a {@link XmlENTITIES} fragment from a String. */
82 public static XmlENTITIES parse(java.lang.String s, org.apache.xmlbeans.XmlOptions options) throws org.apache.xmlbeans.XmlException {
83 return (XmlENTITIES) XmlBeans.getContextTypeLoader().parse( s, type, options ); }
84
85 /** Parses a {@link XmlENTITIES} fragment from a File. */
86 public static XmlENTITIES parse(java.io.File f) throws org.apache.xmlbeans.XmlException, java.io.IOException {
87 return (XmlENTITIES) XmlBeans.getContextTypeLoader().parse( f, type, null ); }
88
89 /** Parses a {@link XmlENTITIES} fragment from a File. */
90 public static XmlENTITIES parse(java.io.File f, org.apache.xmlbeans.XmlOptions options) throws org.apache.xmlbeans.XmlException, java.io.IOException {
91 return (XmlENTITIES) XmlBeans.getContextTypeLoader().parse( f, type, options ); }
92
93 /** Parses a {@link XmlENTITIES} fragment from a URL. */
94 public static XmlENTITIES parse(java.net.URL u) throws org.apache.xmlbeans.XmlException, java.io.IOException {
95 return (XmlENTITIES) XmlBeans.getContextTypeLoader().parse( u, type, null ); }
96
97 /** Parses a {@link XmlENTITIES} fragment from a URL. */
98 public static XmlENTITIES parse(java.net.URL u, org.apache.xmlbeans.XmlOptions options) throws org.apache.xmlbeans.XmlException, java.io.IOException {
99 return (XmlENTITIES) XmlBeans.getContextTypeLoader().parse( u, type, options ); }
100
101 /** Parses a {@link XmlENTITIES} fragment from an InputStream. */
102 public static XmlENTITIES parse(java.io.InputStream is) throws org.apache.xmlbeans.XmlException, java.io.IOException {
103 return (XmlENTITIES) XmlBeans.getContextTypeLoader().parse( is, type, null ); }
104
105 /** Parses a {@link XmlENTITIES} fragment from an InputStream. */
106 public static XmlENTITIES parse(java.io.InputStream is, org.apache.xmlbeans.XmlOptions options) throws org.apache.xmlbeans.XmlException, java.io.IOException {
107 return (XmlENTITIES) XmlBeans.getContextTypeLoader().parse( is, type, options ); }
108
109 /** Parses a {@link XmlENTITIES} fragment from a Reader. */
110 public static XmlENTITIES parse(java.io.Reader r) throws org.apache.xmlbeans.XmlException, java.io.IOException {
111 return (XmlENTITIES) XmlBeans.getContextTypeLoader().parse( r, type, null ); }
112
113 /** Parses a {@link XmlENTITIES} fragment from a Reader. */
114 public static XmlENTITIES parse(java.io.Reader r, org.apache.xmlbeans.XmlOptions options) throws org.apache.xmlbeans.XmlException, java.io.IOException {
115 return (XmlENTITIES) XmlBeans.getContextTypeLoader().parse( r, type, options ); }
116
117 /** Parses a {@link XmlENTITIES} fragment from a DOM Node. */
118 public static XmlENTITIES parse(org.w3c.dom.Node node) throws org.apache.xmlbeans.XmlException {
119 return (XmlENTITIES) XmlBeans.getContextTypeLoader().parse( node, type, null ); }
120
121 /** Parses a {@link XmlENTITIES} fragment from a DOM Node. */
122 public static XmlENTITIES parse(org.w3c.dom.Node node, org.apache.xmlbeans.XmlOptions options) throws org.apache.xmlbeans.XmlException {
123 return (XmlENTITIES) XmlBeans.getContextTypeLoader().parse( node, type, options ); }
124
125 /** Parses a {@link XmlENTITIES} fragment from an XMLInputStream.
126 * @deprecated XMLInputStream was deprecated by XMLStreamReader from STaX - jsr173 API.
127 */
128 public static XmlENTITIES parse(org.apache.xmlbeans.xml.stream.XMLInputStream xis) throws org.apache.xmlbeans.XmlException, org.apache.xmlbeans.xml.stream.XMLStreamException {
129 return (XmlENTITIES) XmlBeans.getContextTypeLoader().parse( xis, type, null ); }
130
131 /** Parses a {@link XmlENTITIES} fragment from an XMLInputStream.
132 * @deprecated XMLInputStream was deprecated by XMLStreamReader from STaX - jsr173 API.
133 */
134 public static XmlENTITIES parse(org.apache.xmlbeans.xml.stream.XMLInputStream xis, org.apache.xmlbeans.XmlOptions options) throws org.apache.xmlbeans.XmlException, org.apache.xmlbeans.xml.stream.XMLStreamException {
135 return (XmlENTITIES) XmlBeans.getContextTypeLoader().parse( xis, type, options ); }
136
137 /** Parses a {@link XmlENTITIES} fragment from an XMLStreamReader. */
138 public static XmlENTITIES parse(javax.xml.stream.XMLStreamReader xsr) throws org.apache.xmlbeans.XmlException {
139 return (XmlENTITIES) XmlBeans.getContextTypeLoader().parse( xsr, type, null ); }
140
141 /** Parses a {@link XmlENTITIES} fragment from an XMLStreamReader. */
142 public static XmlENTITIES parse(javax.xml.stream.XMLStreamReader xsr, org.apache.xmlbeans.XmlOptions options) throws org.apache.xmlbeans.XmlException{
143 return (XmlENTITIES) XmlBeans.getContextTypeLoader().parse( xsr, type, options ); }
144
145 /** Returns a validating XMLInputStream.
146 * @deprecated XMLInputStream was deprecated by XMLStreamReader from STaX - jsr173 API.
147 */
148 public static org.apache.xmlbeans.xml.stream.XMLInputStream newValidatingXMLInputStream(org.apache.xmlbeans.xml.stream.XMLInputStream xis) throws org.apache.xmlbeans.XmlException, org.apache.xmlbeans.xml.stream.XMLStreamException {
149 return XmlBeans.getContextTypeLoader().newValidatingXMLInputStream( xis, type, null ); }
150
151 /** Returns a validating XMLInputStream.
152 * @deprecated XMLInputStream was deprecated by XMLStreamReader from STaX - jsr173 API.
153 */
154 public static org.apache.xmlbeans.xml.stream.XMLInputStream newValidatingXMLInputStream(org.apache.xmlbeans.xml.stream.XMLInputStream xis, org.apache.xmlbeans.XmlOptions options) throws org.apache.xmlbeans.XmlException, org.apache.xmlbeans.xml.stream.XMLStreamException {
155 return XmlBeans.getContextTypeLoader().newValidatingXMLInputStream( xis, type, options ); }
156
157 private Factory() { } // No instance of this class allowed
158 }
159 }
160