Class DefaultStAXFilter

java.lang.Object
org.jdom2.input.stax.DefaultStAXFilter
All Implemented Interfaces:
StAXFilter

public class DefaultStAXFilter extends Object implements StAXFilter
This DefaultStAXFilter includes all content and prunes nothing.

Override this class to make adjustments to get the results you need.

Author:
Rolf Lear
See Also:
  • Constructor Details

    • DefaultStAXFilter

      public DefaultStAXFilter()
  • Method Details

    • includeDocType

      public boolean includeDocType()
      Description copied from interface: StAXFilter
      The current event is a DocType event.
      Specified by:
      includeDocType in interface StAXFilter
      Returns:
      true if the DocType should become a JDOM Fragment.
    • includeElement

      public boolean includeElement(int depth, String name, Namespace ns)
      Description copied from interface: StAXFilter
      The current event is an Element event.

      If the return value of this call is true, then this Element will be processed as a JDOM fragment. You may then get calls to the prune* methods to determine whether child content of this Element should be pruned.

      Specified by:
      includeElement in interface StAXFilter
      Parameters:
      depth - The depth of this content from the document root (the root Element is at depth 0)
      name - The XML tag name of this Element
      ns - The Namespace of this Element
      Returns:
      true if the Element should become a JDOM Fragment.
    • includeComment

      public String includeComment(int depth, String comment)
      Description copied from interface: StAXFilter
      The current event is a Comment event.

      A null return value will cause the Comment to be ignored, and a non-null return value will become the Comment's text.

      To include the comment as-is, do:

       public String includeComment(int depth, String comment) {
           return comment;
       }
       
      Specified by:
      includeComment in interface StAXFilter
      Parameters:
      depth - The depth of this content from the document root (the root Element is at depth 0)
      comment - The Comment value
      Returns:
      null if you want to exclude this comment, or a non-null value which will become the new comment value.
    • includeEntityRef

      public boolean includeEntityRef(int depth, String name)
      Description copied from interface: StAXFilter
      The current event is an EntityRef event.

      Specified by:
      includeEntityRef in interface StAXFilter
      Parameters:
      depth - The depth of this content from the document root (the root Element is at depth 0)
      name - The EntityRef name
      Returns:
      true if you want to include this EntityRef.
    • includeCDATA

      public String includeCDATA(int depth, String text)
      Description copied from interface: StAXFilter
      The current event is a CDATA event.

      A null return value will cause the Comment to be ignored, and a non-null return value will become the CDATA's text.

      To include the CDATA as-is, do:

       public String includeCDATA(int depth, String text) {
           return text;
       }
       
      Specified by:
      includeCDATA in interface StAXFilter
      Parameters:
      depth - The depth of this content from the document root (the root Element is at depth 0)
      text - The CDATA text value
      Returns:
      null if you want to exclude this CDATA, or a non-null value which will become the new CDATA text value.
    • includeText

      public String includeText(int depth, String text)
      Description copied from interface: StAXFilter
      The current event is a TEXT event.

      A null return value will cause the Comment to be ignored, and a non-null return value will become the Text's text.

      To include the Text as-is, do:

       public String includeText(int depth, String text) {
           return text;
       }
       
      Specified by:
      includeText in interface StAXFilter
      Parameters:
      depth - The depth of this content from the document root (the root Element is at depth 0)
      text - The Text value
      Returns:
      null if you want to exclude this Text, or a non-null value which will become the new Text value.
    • includeProcessingInstruction

      public boolean includeProcessingInstruction(int depth, String target)
      Description copied from interface: StAXFilter
      The current event is a ProcessingInstruction event.

      Specified by:
      includeProcessingInstruction in interface StAXFilter
      Parameters:
      depth - The depth of this content from the document root (the root Element is at depth 0)
      target - The ProcessingInstruction Target value
      Returns:
      true if you want to include this ProcessingInstruction.
    • pruneElement

      public boolean pruneElement(int depth, String name, Namespace ns)
      Description copied from interface: StAXFilter
      An Element is being included, and this is a child Element event of the included parent Element. Should this Child Element be pruned from the parent fragment?
      Specified by:
      pruneElement in interface StAXFilter
      Parameters:
      depth - The depth of this content from the document root (the root Element is at depth 0)
      name - The XML tag name of this child Element
      ns - The Namespace of this child Element
      Returns:
      true if the child Element should be excluded.
    • pruneComment

      public String pruneComment(int depth, String comment)
      Description copied from interface: StAXFilter
      An Element is being included, and this is a child Comment event of the included parent Element. Should this child Comment be pruned from the parent fragment?

      A non-null return value will become the Comment value. Return null to skip the Comment.

      To include the Comment as-is, do:

       public String pruneComment(int depth, String comment) {
           return comment;
       }
       
      Specified by:
      pruneComment in interface StAXFilter
      Parameters:
      depth - The depth of this content from the document root (the root Element is at depth 0)
      comment - The Comment value
      Returns:
      null if you want to exclude this Comment, or a non-null value which will become the new Comment value.
    • pruneEntityRef

      public boolean pruneEntityRef(int depth, String name)
      Description copied from interface: StAXFilter
      An Element is being included, and this is a child EntityRef event of the included parent Element. Should this child EntityRef be pruned from the parent fragment?

      Specified by:
      pruneEntityRef in interface StAXFilter
      Parameters:
      depth - The depth of this content from the document root (the root Element is at depth 0)
      name - The EntityRef name
      Returns:
      true if you want to exclude this EntityRef.
    • pruneCDATA

      public String pruneCDATA(int depth, String text)
      Description copied from interface: StAXFilter
      An Element is being included, and this is a child CDATA event of the included parent Element. Should this child CDATA be pruned from the parent fragment?

      A non-null return value will become the CDATA text. Return null to skip the CDATA.

      To include the CDATA as-is, do:

       public String pruneCDATA(int depth, String text) {
           return text;
       }
       
      Specified by:
      pruneCDATA in interface StAXFilter
      Parameters:
      depth - The depth of this content from the document root (the root Element is at depth 0)
      text - The CDATA text value
      Returns:
      null if you want to exclude this CDATA, or a non-null value which will become the new CDATA text value.
    • pruneText

      public String pruneText(int depth, String text)
      Description copied from interface: StAXFilter
      An Element is being included, and this is a child Text event of the included parent Element. Should this child Text be pruned from the parent fragment?

      A non-null return value will become the Text. Return null to skip the Text.

      To include the Text as-is, do:

       public String pruneText(int depth, String text) {
           return text;
       }
       
      Specified by:
      pruneText in interface StAXFilter
      Parameters:
      depth - The depth of this content from the document root (the root Element is at depth 0)
      text - The Text value
      Returns:
      null if you want to exclude this Text, or a non-null value which will become the new Text value.
    • pruneProcessingInstruction

      public boolean pruneProcessingInstruction(int depth, String target)
      Description copied from interface: StAXFilter
      An Element is being included, and this is a child ProcessingInstruction event of the included parent Element. Should this ProcessingInstruction be pruned from the parent fragment?

      Specified by:
      pruneProcessingInstruction in interface StAXFilter
      Parameters:
      depth - The depth of this content from the document root (the root Element is at depth 0)
      target - The ProcessingInstruction Target value
      Returns:
      true if you want to exclude this ProcessingInstruction.