goldengine.java
Class VariableType

java.lang.Object
  |
  +--goldengine.java.VariableType

public class VariableType

extends java.lang.Object

-------------------------------------------------------------------------------------------
Source File: VariableType.java
Author: Devin Cook, Matthew Hawkins
Description: A VariableType holds information specific to this grammar, from the author to whether or not it is case sensitive.
-------------------------------------------------------------------------------------------
Revision List

      Author          Version         Description
      ------          -------         -----------
      MPH             1.0             First Issue

-------------------------------------------------------------------------------------------
IMPORT: NONE
-------------------------------------------------------------------------------------------

Constructor Summary

VariableType(java.lang.String theName, java.lang.String theValue, java.lang.String theComment, boolean isVisible)
VariableType The constructor creates a new Variable.

Method Summary

java.lang.String	getComment() getComment This method will get the comment of this variable.
java.lang.String	getName() getName This method will get the name of this variable.
java.lang.String	getValue() getValue This method will get the value of this variable.
boolean	getVisible() getVisible This method will get whether or not this variable is public.
void	setComment(java.lang.String newComment) setComment This method will set the comment of this variable to that passed in.
void	setName(java.lang.String newName) setName This method will set the name of this variable to that passed in.
void	setValue(java.lang.String newValue) setValue This method will set the value of this variable to that passed in.
void	setVisible(boolean isVisible) setVisible This method will set whether or not this variable is visible.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VariableType

public VariableType(java.lang.String theName,
                    java.lang.String theValue,
                    java.lang.String theComment,
                    boolean isVisible)

VariableType The constructor creates a new Variable.

Parameters:

theName - The name of the variable.

theValue - The value of the variable.

theComment - The comment associated with this variable.

isVisible - True if it public, false if not.

Method Detail

getName

public java.lang.String getName()

getName This method will get the name of this variable.

Returns:

The name of this variable.

getValue

public java.lang.String getValue()

getValue This method will get the value of this variable.

Returns:

The value of this variable.

getComment

public java.lang.String getComment()

getComment This method will get the comment of this variable.

Returns:

The comment of this variable.

getVisible

public boolean getVisible()

getVisible This method will get whether or not this variable is public.

Returns:

True if it is visible, false if not.

setName

public void setName(java.lang.String newName)

setName This method will set the name of this variable to that passed in.

Parameters:

newName - The new name of the variable.

setValue

public void setValue(java.lang.String newValue)

setValue This method will set the value of this variable to that passed in.

Parameters:

newValue - The new value of the variable.

setComment

public void setComment(java.lang.String newComment)

setComment This method will set the comment of this variable to that passed in.

Parameters:

newComment - The new comment of the variable.

setVisible

public void setVisible(boolean isVisible)

setVisible This method will set whether or not this variable is visible.

Parameters:

isVisible - True if it is visible, false if not.