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

Quick Search    Search Deep

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

java.lang.Object
  extended byorg.pqt.autorib.rib.RIBParams

public class RIBParams
extends java.lang.Object

A class to store parameters for a shader or other object. Parameters are in the form of a string name followed by a value e.g "Ks" .4, or "shadow" "myfile". Each name in the parameter list is unique.


Nested Class Summary
protected  class RIBParams.ParamRec
           
 
Field Summary
(package private)  java.util.Vector params
           
 
Constructor Summary
RIBParams()
          The default constructor
RIBParams(RIBParams r)
          This creates a new set of parameters based on an existing set (which is cloned)
 
Method Summary
 void add(java.lang.String key, org.pqt.autorib.tokenizer.Token value)
          Add a new parameter and value to the parameters list.
 void clear()
          Empty the parameter list
 org.pqt.autorib.tokenizer.Token get(java.lang.String key)
          Returns a the value of a parameter with a given name
 void read(org.pqt.autorib.tokenizer.Tokenizer in)
          Read in a set of parameters of the form "name" value
 void remove(java.lang.String key)
          Remove the named parameter from the list.
 boolean replace(java.lang.String key, org.pqt.autorib.tokenizer.Token value)
          Replaces the value of parameter with the given name with a new one.
 int size()
          Return the number of parameters in the list
 void write(java.io.Writer out)
          Write a set of parameters to the given output
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

params

java.util.Vector params
Constructor Detail

RIBParams

public RIBParams()
The default constructor


RIBParams

public RIBParams(RIBParams r)
This creates a new set of parameters based on an existing set (which is cloned)

Method Detail

read

public void read(org.pqt.autorib.tokenizer.Tokenizer in)
          throws org.pqt.autorib.tokenizer.FormatException,
                 java.io.IOException
Read in a set of parameters of the form "name" value


write

public void write(java.io.Writer out)
           throws java.io.IOException
Write a set of parameters to the given output


get

public org.pqt.autorib.tokenizer.Token get(java.lang.String key)
Returns a the value of a parameter with a given name


replace

public boolean replace(java.lang.String key,
                       org.pqt.autorib.tokenizer.Token value)
Replaces the value of parameter with the given name with a new one. If a parameter of the given name does not exist it is created, and appended to the list of parameters


add

public void add(java.lang.String key,
                org.pqt.autorib.tokenizer.Token value)
Add a new parameter and value to the parameters list. If a parameter of the name already exists, its value is changed to match the new value


remove

public void remove(java.lang.String key)
Remove the named parameter from the list. If the name does not exist, fail silently.


clear

public void clear()
Empty the parameter list


size

public int size()
Return the number of parameters in the list