Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| xmlgraphics-commons 2.3
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.xmlgraphics.ps.dsc.events
Class DSCCommentBeginDocument

    java.lang.Object
      org.apache.xmlgraphics.ps.dsc.events.AbstractEvent
          org.apache.xmlgraphics.ps.dsc.events.AbstractDSCComment
              org.apache.xmlgraphics.ps.dsc.events.DSCCommentBeginDocument

All Implemented Interfaces:
  DSCParserConstants, DSCComment, DSCEvent

    public class DSCCommentBeginDocument

extends AbstractDSCComment

Represents a %BeginDocument DSC comment.

Field Summary

Fields inherited from interface org.apache.xmlgraphics.ps.dsc.DSCParserConstants
`COMMENT, DSC_COMMENT, EOF, HEADER_COMMENT, LINE`

Constructor Summary
`DSCCommentBeginDocument()` Creates a new instance
`DSCCommentBeginDocument(PSResource resource)` Creates a new instance for a given PSResource instance
`DSCCommentBeginDocument(PSResource resource, java.lang.Float version, java.lang.String type)` Creates a new instance for a given PSResource instance

Method Summary
`void` | `generate(PSGenerator gen)` Writes the event to the given PSGenerator.
`java.lang.String` | `getName()` Returns the name of the DSC comment.
`PSResource` | `getResource()` Returns the associated PSResource.
`java.lang.String` | `getType()` Returns the resource type
`java.lang.Float` | `getVersion()` Returns the resource version.
`boolean` | `hasValues()` Indicates whether this DSC comment has values.
`void` | `parseValue(java.lang.String value)` Parses the value of the DSC comment.

Methods inherited from class org.apache.xmlgraphics.ps.dsc.events.AbstractDSCComment
`asDSCComment, getEventType, isAtend, isDSCComment, splitParams`

Methods inherited from class org.apache.xmlgraphics.ps.dsc.events.AbstractEvent
`asLine, isComment, isHeaderComment, isLine`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface org.apache.xmlgraphics.ps.dsc.events.DSCEvent
`asLine, isComment, isHeaderComment, isLine`

Constructor Detail

### DSCCommentBeginDocument

    public DSCCommentBeginDocument()

  Creates a new instance

### DSCCommentBeginDocument

    public DSCCommentBeginDocument(PSResource resource)

  Creates a new instance for a given PSResource instance

  Parameters:
    `resource` - the resource

### DSCCommentBeginDocument

    public DSCCommentBeginDocument(PSResource resource,
                                   java.lang.Float version,
                                   java.lang.String type)

  Creates a new instance for a given PSResource instance

  Parameters:
    `resource` - the resource
    `version` - the version of the resource (or null)
    `type` - the type of resource (or null)

Method Detail

### getVersion

    public java.lang.Float getVersion()

  Returns the resource version.

  Returns:
    the resource version (or null if not applicable)

### getType

    public java.lang.String getType()

  Returns the resource type

  Returns:
    the resource type (or null if not applicable)

### getName

    public java.lang.String getName()

  Returns the name of the DSC comment.

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

### getResource

    public PSResource getResource()

  Returns the associated PSResource.

  Returns:
    the resource

### hasValues

    public boolean hasValues()

  Indicates whether this DSC comment has values.

  Returns:
    true if the DSC comment has values

### parseValue

    public void parseValue(java.lang.String value)

  Parses the value of the DSC comment.

  Parameters:
    `value` - the value

### generate

    public void generate(PSGenerator gen)
                  throws java.io.IOException

  Writes the event to the given PSGenerator.

  Parameters:
    `gen` - the PSGenerator to write to
  Throws:
    `java.io.IOException` - In case of an I/O error
  See Also:
    `DSCEvent.generate( org.apache.xmlgraphics.ps.PSGenerator)`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| xmlgraphics-commons 2.3
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright 1999-2018 The Apache Software Foundation. All Rights Reserved.