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
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
ConstructorsConstructorDescriptionCreates a new instanceDSCCommentBeginDocument
(PSResource resource) Creates a new instance for a given PSResource instanceDSCCommentBeginDocument
(PSResource resource, Float version, String type) Creates a new instance for a given PSResource instance -
Method Summary
Modifier and TypeMethodDescriptionvoid
generate
(PSGenerator gen) Writes the event to the given PSGenerator.getName()
Returns the name of the DSC comment.Returns the associated PSResource.getType()
Returns the resource typeReturns the resource version.boolean
Indicates whether this DSC comment has values.void
parseValue
(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 Details
-
DSCCommentBeginDocument
public DSCCommentBeginDocument()Creates a new instance -
DSCCommentBeginDocument
Creates a new instance for a given PSResource instance- Parameters:
resource
- the resource
-
DSCCommentBeginDocument
Creates a new instance for a given PSResource instance- Parameters:
resource
- the resourceversion
- the version of the resource (or null)type
- the type of resource (or null)
-
-
Method Details
-
getVersion
Returns the resource version.- Returns:
- the resource version (or null if not applicable)
-
getType
Returns the resource type- Returns:
- the resource type (or null if not applicable)
-
getName
Returns the name of the DSC comment.- Returns:
- the name of the DSC comment (without the "%%" prefix)
-
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
Parses the value of the DSC comment.- Parameters:
value
- the value
-
generate
Writes the event to the given PSGenerator.- Parameters:
gen
- the PSGenerator to write to- Throws:
IOException
- In case of an I/O error- See Also:
-