< prev index next >

src/java.xml/share/classes/javax/xml/stream/events/Characters.java

Print this page

        

@@ -1,7 +1,7 @@
 /*
- * Copyright (c) 2009, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2009, 2020, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
  * under the terms of the GNU General Public License version 2 only, as
  * published by the Free Software Foundation.  Oracle designates this

@@ -38,19 +38,21 @@
  * @since 1.6
  */
 public interface Characters extends XMLEvent {
   /**
    * Get the character data of this event
+   * @return the character data
    */
   public String getData();
 
   /**
    * Returns true if this set of Characters
    * is all whitespace.  Whitespace inside a document
    * is reported as CHARACTERS.  This method allows
    * checking of CHARACTERS events to see if they
    * are composed of only whitespace characters
+   * @return true if the {@code Characters} are all whitespace, false otherwise
    */
   public boolean isWhiteSpace();
 
   /**
    * Returns true if this is a CData section.  If this

@@ -58,16 +60,18 @@
    *
    * If javax.xml.stream.isCoalescing is set to true CDATA Sections
    * that are surrounded by non CDATA characters will be reported
    * as a single Characters event. This method will return false
    * in this case.
+   * @return true if it is {@code CDATA}, false otherwise
    */
   public boolean isCData();
 
   /**
    * Return true if this is ignorableWhiteSpace.  If
    * this event is ignorableWhiteSpace its event type will
    * be SPACE.
+   * @return true if it is ignorable whitespace, false otherwise
    */
   public boolean isIgnorableWhiteSpace();
 
 }
< prev index next >