Module org.apache.xmlgraphics.commons
Package org.apache.xmlgraphics.ps.dsc.events

Interface DSCComment

All Superinterfaces:
DSCEvent, DSCParserConstants
All Known Implementing Classes:
AbstractDSCComment, AbstractResourceDSCComment, AbstractResourcesDSCComment, DSCAtend, DSCCommentBeginDocument, DSCCommentBeginResource, DSCCommentBoundingBox, DSCCommentDocumentNeededResources, DSCCommentDocumentSuppliedResources, DSCCommentEndComments, DSCCommentEndOfFile, DSCCommentHiResBoundingBox, DSCCommentIncludeResource, DSCCommentLanguageLevel, DSCCommentPage, DSCCommentPageBoundingBox, DSCCommentPageHiResBoundingBox, DSCCommentPageResources, DSCCommentPages, DSCCommentTitle, UnparsedDSCComment
public interface DSCComment extends DSCEvent
Base interface for all DSC comments.

  • Method Details

    • getName

      String getName()
      Returns the name of the DSC comment.
      Returns:
      the name of the DSC comment (without the "%%" prefix)

    • parseValue

      void parseValue(String value)
      Parses the value of the DSC comment.
      Parameters:
      value - the value

    • hasValues

      boolean hasValues()
      Indicates whether this DSC comment has values.
      Returns:
      true if the DSC comment has values

    • isAtend

      boolean isAtend()
      Indicates whether the DSC comment's value is "Atend".
      Returns:
      true if the value is "Atend"

    • generate

      void generate(PSGenerator gen) throws IOException
      Description copied from interface: DSCEvent
      Writes the event to the given PSGenerator.
      Specified by:
      generate in interface DSCEvent
      Parameters:
      gen - the PSGenerator to write to
      Throws:
      IOException - In case of an I/O error
      See Also: