xmlgraphics-commons 1.2

org.apache.xmlgraphics.ps.dsc.events
Class DSCCommentBeginResource

java.lang.Object
  extended by org.apache.xmlgraphics.ps.dsc.events.AbstractEvent
      extended by org.apache.xmlgraphics.ps.dsc.events.AbstractDSCComment
          extended by org.apache.xmlgraphics.ps.dsc.events.DSCCommentBeginResource
All Implemented Interfaces:
DSCParserConstants, DSCComment, DSCEvent

public class DSCCommentBeginResource
extends AbstractDSCComment

Represents a %BeginResource DSC comment.


Field Summary
 
Fields inherited from interface org.apache.xmlgraphics.ps.dsc.DSCParserConstants
COMMENT, DSC_COMMENT, EOF, HEADER_COMMENT, LINE
 
Constructor Summary
DSCCommentBeginResource()
          Creates a new instance
DSCCommentBeginResource(PSResource resource)
          Creates a new instance for a given PSResource instance
DSCCommentBeginResource(PSResource resource, int min, int max)
          Creates a new instance for a given PSResource instance
 
Method Summary
 void generate(PSGenerator gen)
          Writes the event to the given PSGenerator.
 java.lang.Integer getMax()
          Returns the maximum VM used by the resource.
 java.lang.Integer getMin()
          Returns the minimum VM used by the resource.
 java.lang.String getName()
          Returns the name of the DSC comment.
 PSResource getResource()
          Returns the associated PSResource.
 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

DSCCommentBeginResource

public DSCCommentBeginResource()
Creates a new instance


DSCCommentBeginResource

public DSCCommentBeginResource(PSResource resource)
Creates a new instance for a given PSResource instance

Parameters:
resource - the resource

DSCCommentBeginResource

public DSCCommentBeginResource(PSResource resource,
                               int min,
                               int max)
Creates a new instance for a given PSResource instance

Parameters:
resource - the resource
min - Minimum VM used by the resource
max - Maximum VM used by the resource
Method Detail

getResource

public PSResource getResource()
Returns the associated PSResource.

Returns:
the resource

getMin

public java.lang.Integer getMin()
Returns the minimum VM used by the resource.

Returns:
the minimum VM used by the resource

getMax

public java.lang.Integer getMax()
Returns the maximum VM used by the resource.

Returns:
the maximum VM used by the resource

getName

public java.lang.String getName()
Description copied from interface: DSCComment
Returns the name of the DSC comment.

Returns:
the name of the DSC comment (without the "%%" prefix)
See Also:
DSCComment.getName()

hasValues

public boolean hasValues()
Description copied from interface: DSCComment
Indicates whether this DSC comment has values.

Returns:
true if the DSC comment has values
See Also:
DSCComment.hasValues()

parseValue

public void parseValue(java.lang.String value)
Description copied from interface: DSCComment
Parses the value of the DSC comment.

Parameters:
value - the value
See Also:
DSCComment.parseValue(java.lang.String)

generate

public void generate(PSGenerator gen)
              throws java.io.IOException
Description copied from interface: DSCEvent
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)

xmlgraphics-commons 1.2

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