|
12005
|
1 |
/*
|
|
42802
|
2 |
* Copyright (c) 2009, Oracle and/or its affiliates. All rights reserved.
|
|
12005
|
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
|
|
|
23 |
* questions.
|
|
|
24 |
*/
|
|
|
25 |
|
|
|
26 |
package javax.xml.stream.events;
|
|
|
27 |
|
|
|
28 |
/**
|
|
|
29 |
* This describes the interface to Characters events.
|
|
|
30 |
* All text events get reported as Characters events.
|
|
|
31 |
* Content, CData and whitespace are all reported as
|
|
|
32 |
* Characters events. IgnorableWhitespace, in most cases,
|
|
|
33 |
* will be set to false unless an element declaration of element
|
|
|
34 |
* content is present for the current element.
|
|
|
35 |
*
|
|
|
36 |
* @version 1.0
|
|
|
37 |
* @author Copyright (c) 2009 by Oracle Corporation. All Rights Reserved.
|
|
|
38 |
* @since 1.6
|
|
|
39 |
*/
|
|
|
40 |
public interface Characters extends XMLEvent {
|
|
|
41 |
/**
|
|
|
42 |
* Get the character data of this event
|
|
|
43 |
*/
|
|
|
44 |
public String getData();
|
|
|
45 |
|
|
|
46 |
/**
|
|
|
47 |
* Returns true if this set of Characters
|
|
|
48 |
* is all whitespace. Whitespace inside a document
|
|
|
49 |
* is reported as CHARACTERS. This method allows
|
|
|
50 |
* checking of CHARACTERS events to see if they
|
|
|
51 |
* are composed of only whitespace characters
|
|
|
52 |
*/
|
|
|
53 |
public boolean isWhiteSpace();
|
|
|
54 |
|
|
|
55 |
/**
|
|
|
56 |
* Returns true if this is a CData section. If this
|
|
|
57 |
* event is CData its event type will be CDATA
|
|
|
58 |
*
|
|
|
59 |
* If javax.xml.stream.isCoalescing is set to true CDATA Sections
|
|
|
60 |
* that are surrounded by non CDATA characters will be reported
|
|
|
61 |
* as a single Characters event. This method will return false
|
|
|
62 |
* in this case.
|
|
|
63 |
*/
|
|
|
64 |
public boolean isCData();
|
|
|
65 |
|
|
|
66 |
/**
|
|
|
67 |
* Return true if this is ignorableWhiteSpace. If
|
|
|
68 |
* this event is ignorableWhiteSpace its event type will
|
|
|
69 |
* be SPACE.
|
|
|
70 |
*/
|
|
|
71 |
public boolean isIgnorableWhiteSpace();
|
|
|
72 |
|
|
|
73 |
}
|