1 /* 2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 3 * 4 * This code is free software; you can redistribute it and/or modify it 5 * under the terms of the GNU General Public License version 2 only, as 6 * published by the Free Software Foundation. Oracle designates this 7 * particular file as subject to the "Classpath" exception as provided 8 * by Oracle in the LICENSE file that accompanied this code. 9 * 10 * This code is distributed in the hope that it will be useful, but WITHOUT 11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 13 * version 2 for more details (a copy is included in the LICENSE file that 14 * accompanied this code). 15 * 16 * You should have received a copy of the GNU General Public License version 17 * 2 along with this work; if not, write to the Free Software Foundation, 18 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 19 * 20 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 21 * or visit www.oracle.com if you need additional information or have any 22 * questions. 23 */ 24 25 /* 26 * Copyright (c) 2009 by Oracle Corporation. All Rights Reserved. 27 */ 28 29 package javax.xml.stream.events; 30 31 /** 32 * This describes the interface to Characters events. 33 * All text events get reported as Characters events. 34 * Content, CData and whitespace are all reported as 35 * Characters events. IgnorableWhitespace, in most cases, 36 * will be set to false unless an element declaration of element 37 * content is present for the current element. 38 * 39 * @version 1.0 40 * @author Copyright (c) 2009 by Oracle Corporation. All Rights Reserved. 41 * @since 1.6 42 */ 43 public interface Characters extends XMLEvent { 44 /** 45 * Get the character data of this event 46 */ 47 public String getData(); 48 49 /** 50 * Returns true if this set of Characters 51 * is all whitespace. Whitespace inside a document 52 * is reported as CHARACTERS. This method allows 53 * checking of CHARACTERS events to see if they 54 * are composed of only whitespace characters 55 */ 56 public boolean isWhiteSpace(); 57 58 /** 59 * Returns true if this is a CData section. If this 60 * event is CData its event type will be CDATA 61 * 62 * If javax.xml.stream.isCoalescing is set to true CDATA Sections 63 * that are surrounded by non CDATA characters will be reported 64 * as a single Characters event. This method will return false 65 * in this case. 66 */ 67 public boolean isCData(); 68 69 /** 70 * Return true if this is ignorableWhiteSpace. If 71 * this event is ignorableWhiteSpace its event type will 72 * be SPACE. 73 */ 74 public boolean isIgnorableWhiteSpace(); 75 76 }