Class EntityDecl

  • All Implemented Interfaces:
    javax.xml.stream.events.EntityDeclaration, javax.xml.stream.events.XMLEvent, javax.xml.stream.XMLStreamConstants, org.codehaus.stax2.evt.XMLEvent2
    Direct Known Subclasses:
    ExtEntity, IntEntity

    public abstract class EntityDecl
    extends WEntityDeclaration
    Abstract base class for various entity declarations DTD reader has parsed from DTD subsets.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      (package private) java.net.URL mContext
      Context that is to be used to resolve references encountered from expanded contents of this entity.
      protected boolean mDeclaredExternally
      Flag that can be set to indicate that the declaration was in the external DTD subset.
      (package private) java.lang.String mName
      Name/id of the entity used to reference it.
      • Fields inherited from class org.codehaus.stax2.ri.evt.BaseEventImpl

        mLocation
      • Fields inherited from interface javax.xml.stream.XMLStreamConstants

        ATTRIBUTE, CDATA, CHARACTERS, COMMENT, DTD, END_DOCUMENT, END_ELEMENT, ENTITY_DECLARATION, ENTITY_REFERENCE, NAMESPACE, NOTATION_DECLARATION, PROCESSING_INSTRUCTION, SPACE, START_DOCUMENT, START_ELEMENT
    • Constructor Summary

      Constructors 
      Constructor Description
      EntityDecl​(javax.xml.stream.Location loc, java.lang.String name, java.net.URL ctxt)  
    • Field Detail

      • mName

        final java.lang.String mName
        Name/id of the entity used to reference it.
      • mContext

        final java.net.URL mContext
        Context that is to be used to resolve references encountered from expanded contents of this entity.
      • mDeclaredExternally

        protected boolean mDeclaredExternally
        Flag that can be set to indicate that the declaration was in the external DTD subset. Default is false.
    • Constructor Detail

      • EntityDecl

        public EntityDecl​(javax.xml.stream.Location loc,
                          java.lang.String name,
                          java.net.URL ctxt)
    • Method Detail

      • markAsExternallyDeclared

        public void markAsExternallyDeclared()
      • getBaseURI

        public final java.lang.String getBaseURI()
        Specified by:
        getBaseURI in interface javax.xml.stream.events.EntityDeclaration
        Specified by:
        getBaseURI in class WEntityDeclaration
      • getName

        public final java.lang.String getName()
        Specified by:
        getName in interface javax.xml.stream.events.EntityDeclaration
        Specified by:
        getName in class WEntityDeclaration
      • getNotationName

        public abstract java.lang.String getNotationName()
        Specified by:
        getNotationName in interface javax.xml.stream.events.EntityDeclaration
        Specified by:
        getNotationName in class WEntityDeclaration
      • getPublicId

        public abstract java.lang.String getPublicId()
        Specified by:
        getPublicId in interface javax.xml.stream.events.EntityDeclaration
        Specified by:
        getPublicId in class WEntityDeclaration
      • getReplacementText

        public abstract java.lang.String getReplacementText()
        Specified by:
        getReplacementText in interface javax.xml.stream.events.EntityDeclaration
        Specified by:
        getReplacementText in class WEntityDeclaration
      • getReplacementText

        public abstract int getReplacementText​(java.io.Writer w)
                                        throws java.io.IOException
        Throws:
        java.io.IOException
      • getSystemId

        public abstract java.lang.String getSystemId()
        Specified by:
        getSystemId in interface javax.xml.stream.events.EntityDeclaration
        Specified by:
        getSystemId in class WEntityDeclaration
      • wasDeclaredExternally

        public boolean wasDeclaredExternally()
        Returns:
        True, if the declaration occured in the external DTD subset; false if not (internal subset, custom declaration)
      • writeEnc

        public abstract void writeEnc​(java.io.Writer w)
                               throws java.io.IOException
        Specified by:
        writeEnc in class WEntityDeclaration
        Throws:
        java.io.IOException
      • getReplacementChars

        public abstract char[] getReplacementChars()
      • getReplacementTextLength

        public final int getReplacementTextLength()
      • isExternal

        public abstract boolean isExternal()
      • isParsed

        public abstract boolean isParsed()
      • expand

        public abstract WstxInputSource expand​(WstxInputSource parent,
                                               javax.xml.stream.XMLResolver res,
                                               ReaderConfig cfg,
                                               int xmlVersion)
                                        throws java.io.IOException,
                                               javax.xml.stream.XMLStreamException
        Method called to create the new input source through which expansion value of the entity can be read.
        Throws:
        java.io.IOException
        javax.xml.stream.XMLStreamException