Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.pqt.autorib.rib
Class RIBRequest  view RIBRequest download RIBRequest.java

java.lang.Object
  extended byorg.pqt.autorib.rib.RIBRequest
All Implemented Interfaces:
java.lang.Cloneable
Direct Known Subclasses:
RIBBrace, RIBClipping, RIBColor, RIBDeclare, RIBDisplay, RIBFormat, RIBFrameBegin, RIBObjectBegin, RIBObjectGroup, RIBObjectInstance, RIBPrimitive, RIBProjection, RIBReadArchive, RIBShader, RIBStandard, RIBTransform

public abstract class RIBRequest
extends java.lang.Object
implements java.lang.Cloneable

A class to hold a single RIB call.


Field Summary
 boolean deleted
          True if this RIBRequest has been deleted
 java.util.Vector preContent
          A vector of RIBRequests added to this Request during processing of the request by AutoRIB, it is 'pre' in the sense that these requests are written out before the RIBRequest itself
 int requestID
          The ID number of this request
 java.lang.String requestName
          The Name of the RIB Call
 
Constructor Summary
RIBRequest()
          default constructor
RIBRequest(RIBRequest r)
          Construct an RIBRequest based on an existing RIBRequest
 
Method Summary
 void filteredWrite(java.io.Writer out, boolean[] filter)
          Write out both the pre content and the RIBRequest itself, providing it passes the given filter
protected  void filteredWritePreContent(java.io.Writer out, boolean[] filter)
          Write out the pre content, filtering it
 void prepend(RIBRequest rq)
          Add an RIB request to the precontent for this request
 void prepend(java.util.Vector v)
          Add RIB requests to the pre content of this request
abstract  void read(org.pqt.autorib.tokenizer.Tokenizer in)
          read an RIB call and store it
 void readRequestName(org.pqt.autorib.tokenizer.Tokenizer in)
          read in the request name only, and not the associated parameters
 void write(java.io.Writer out)
          write out this RIBRequest, together with any other requests that have been added to it
abstract  void writeOther(java.io.Writer out)
          This method is overridden by subclasses to allow them to actually do the writing out of the Request and associated parameters etc.
protected  void writePreContent(java.io.Writer out)
          Write out only the pre content (RIBRequests added to this one during processing)
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

requestName

public java.lang.String requestName
The Name of the RIB Call


requestID

public int requestID
The ID number of this request


deleted

public boolean deleted
True if this RIBRequest has been deleted


preContent

public java.util.Vector preContent
A vector of RIBRequests added to this Request during processing of the request by AutoRIB, it is 'pre' in the sense that these requests are written out before the RIBRequest itself

Constructor Detail

RIBRequest

public RIBRequest()
default constructor


RIBRequest

public RIBRequest(RIBRequest r)
Construct an RIBRequest based on an existing RIBRequest

Method Detail

write

public void write(java.io.Writer out)
           throws java.io.IOException
write out this RIBRequest, together with any other requests that have been added to it


writePreContent

protected void writePreContent(java.io.Writer out)
                        throws java.io.IOException
Write out only the pre content (RIBRequests added to this one during processing)


filteredWritePreContent

protected void filteredWritePreContent(java.io.Writer out,
                                       boolean[] filter)
                                throws java.io.IOException
Write out the pre content, filtering it


filteredWrite

public void filteredWrite(java.io.Writer out,
                          boolean[] filter)
                   throws java.io.IOException
Write out both the pre content and the RIBRequest itself, providing it passes the given filter


writeOther

public abstract void writeOther(java.io.Writer out)
                         throws java.io.IOException
This method is overridden by subclasses to allow them to actually do the writing out of the Request and associated parameters etc. It is called whenever any of the Write methods above are called.


read

public abstract void read(org.pqt.autorib.tokenizer.Tokenizer in)
                   throws java.io.IOException,
                          org.pqt.autorib.tokenizer.FormatException
read an RIB call and store it


readRequestName

public void readRequestName(org.pqt.autorib.tokenizer.Tokenizer in)
                     throws java.io.IOException,
                            org.pqt.autorib.tokenizer.FormatException
read in the request name only, and not the associated parameters


prepend

public void prepend(RIBRequest rq)
Add an RIB request to the precontent for this request


prepend

public void prepend(java.util.Vector v)
Add RIB requests to the pre content of this request