com.sri.oaa2.icl
Class IclStr

java.lang.Object
  |
  +--com.sri.oaa2.icl.IclTerm
        |
        +--com.sri.oaa2.icl.IclAtomic
              |
              +--com.sri.oaa2.icl.IclStr

All Implemented Interfaces:

java.lang.Cloneable, OaaPrologVocabTokenTypes, java.io.Serializable

public final class IclStr

extends com.sri.oaa2.icl.IclAtomic

Represents an ICL string, such as hello, 'hello', and 'hello.'. Note that calling toString() on an IclStr will quote the value only if quotes are needed.

See Also:

Serialized Form

Field Summary

protected java.lang.String	forcedQuotedValue
protected boolean	hadQuotes
protected java.lang.String	quotedValue
protected java.lang.String	unquotedValue

Fields inherited from class com.sri.oaa2.icl.IclTerm

children, readOnly, type

Fields inherited from interface com.sri.oaa2.icl.OaaPrologVocabTokenTypes

BACKSLASH, BANG, COLON, COMMA, DBL_COLON, DBLQUOTE, DBLQUOTED, DIV, DOT, ENDPAREN_LITERAL, EOF, EQUAL, EXPONENT, FLOAT, GROUP, ICLDATAQ, ICLDATAQ_LITERAL, IDENT, INT, LBRACE, LBRACK, LIST, LPAREN, MINUS, NULL_TREE_LOOKAHEAD, NUM_FLOAT, NUM_INT, PIPE, PLUS, RBRACE, RBRACK, RPAREN, SEMI, SIGNED_EXPONENT, SPECIAL_CHAR_LITERAL, STAR, STR, STRING_LITERAL, STRUCT, TERM_LITERAL, TILDE, TURNSTILE, VAR, VARIABLE, WS

Constructor Summary

IclStr(IclStr s)
Create a new atom from another atom--no error checking is done on the string.

IclStr(java.lang.String s)
Create a new atom from a string--does no error checking on the string.

Method Summary

protected java.lang.Object	accept(OaaPrologVisitor visitor, java.lang.Object data) Accept the visitor.
void	add(IclTerm n) Add a child to the end of the list of children.
void	add(int index, IclTerm n) Add a child to this term at the given index
void	addAll(IclTerm l) Add all the children of the given term to this term.
void	clearTerms() Remove all children of this node.
boolean	equals(java.lang.Object o)
protected IclTerm	getChild(int i) Get the child at the given Index.
java.lang.String	getForcedQuoted(boolean force) Force quoting on a string to avoid expensive needQuotes call.
int	getNumChildren() Get the number of children of this node.
protected java.lang.String	getQuotedValue() Returns the quoted value of this atom.
IclTerm	getTerm(int i) Get the term at the given index.
protected java.lang.String	getValue() Returns the unquoted value of this atom.
int	hashCode()
java.lang.String	iclStr() Deprecated. use toString() or toQuotedString() or toUnquotedString() or getForcedQuoted()
boolean	isAtomic() Check if this term is atomic--can never have children.
boolean	isComposite() Check if this term is composite--can have children.
java.util.Iterator	iterator() Get an iterator for the children of this term.
java.util.ListIterator	listIterator() Get an iterator for the children of this term.
void	removeAllUnifying(IclTerm n) Remove all terms from this term's children for which the given term unifies.
void	removeElement(int i) Remove the child at the given index.
IclTerm	removeUnifying(IclTerm n) Remove the first child found that unifies with the given one.
void	replaceElement(int target, IclTerm replacement) Replace the term at the given index.
void	replaceUnifying(IclTerm target, IclTerm replacement) Replace all terms that unify with target with replacement.
protected void	setForcedQuotedValue(java.lang.String s) Set the forced quoted value.
protected void	setQuotedFromUnquoted(java.lang.String s) Set the quoted string from the unquoted version.
protected void	setQuotedValue(java.lang.String s) Set the quoted value.
protected void	setValue(java.lang.String s, boolean check) Set the value of this atom from a String.
protected void	setValueFromParsed(java.lang.String s) Set the value of this atom from a parsed String.
int	size() Get the number of children of this node.
java.util.ArrayList	toArrayList() Get the children of this node as an ArrayList.
java.lang.String	toIdentifyingString() Get the atom, unquoted.
java.lang.String	toQuotedString() Get the atom, quoting it if needed, and using the unquoted value otherwise.
java.lang.String	toUnquotedString() Get the atom, unquoted, even if it might need quotes.

Methods inherited from class com.sri.oaa2.icl.IclTerm

checkWritable, childrenAccept, clone, dump, fromString, fromString, getChildren, getType, iclAddToList, iclAddToList, iclAppend, iclArguments, iclArgumentsIterator, iclClone, iclDelete, iclDerefTerm, iclFloat, iclFunctor, iclInt, iclListIterator, iclListLen, iclNthTerm, iclNumTerms, iclRemoveElement, iclRemoveFromList, iclReplaceElement, iclReplaceNthTerm, iclRetractAll, iclStarter, iclUnify, iclUnify, iclUnify, isEmptyList, isFloat, isGroup, isIclDataQ, isInt, isList, isOfType, isReadOnly, isStr, isStruct, isVar, setReadOnly, setType, toString, toString, toVector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

unquotedValue

protected java.lang.String unquotedValue

quotedValue

protected java.lang.String quotedValue

forcedQuotedValue

protected java.lang.String forcedQuotedValue

hadQuotes

protected boolean hadQuotes

Constructor Detail

IclStr

public IclStr(java.lang.String s)

Create a new atom from a string--does no error checking on the string. Use IclUtils.fromString() for error checking.

IclStr

public IclStr(IclStr s)

Create a new atom from another atom--no error checking is done on the string.

Method Detail

accept

protected java.lang.Object accept(OaaPrologVisitor visitor,
                                  java.lang.Object data)

Accept the visitor.

Overrides:

accept in class IclTerm

Parameters:

visitor - the visitor

data - generic data for the visitor

Returns:

Object: generic return value

See Also:

for an alternative

getValue

protected java.lang.String getValue()

Returns the unquoted value of this atom.

getQuotedValue

protected java.lang.String getQuotedValue()

Returns the quoted value of this atom.

getForcedQuoted

public java.lang.String getForcedQuoted(boolean force)

Force quoting on a string to avoid expensive needQuotes call.

setForcedQuotedValue

protected void setForcedQuotedValue(java.lang.String s)

Set the forced quoted value.

setQuotedValue

protected void setQuotedValue(java.lang.String s)

Set the quoted value.

setQuotedFromUnquoted

protected void setQuotedFromUnquoted(java.lang.String s)

Set the quoted string from the unquoted version. This will check if it actually needs quotes, and won't put them on if not needed.

setValue

protected void setValue(java.lang.String s,
                        boolean check)

Set the value of this atom from a String. Again, no checking is done on the String. This should be the only way that any value is set, except indirectly by getQuotedValue(). Unfortunately, we can't cache the quotedValue here, as we may have been given an unquotedValue which was not valid as a quotedValue in the constructor.

setValueFromParsed

protected void setValueFromParsed(java.lang.String s)

Set the value of this atom from a parsed String. Again, no checking is done on the String.

toQuotedString

public java.lang.String toQuotedString()

Get the atom, quoting it if needed, and using the unquoted value otherwise. Prefer toString().

toUnquotedString

public java.lang.String toUnquotedString()

Get the atom, unquoted, even if it might need quotes. Prefer toString().

toIdentifyingString

public java.lang.String toIdentifyingString()

Get the atom, unquoted. Prefer toString().

Overrides:

toIdentifyingString in class IclTerm

iclStr

public java.lang.String iclStr()

Deprecated. use toString() or toQuotedString() or toUnquotedString() or getForcedQuoted()

Overrides:

iclStr in class IclTerm

See Also:

toQuotedString(), toUnquotedString()

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class com.sri.oaa2.icl.IclAtomic

isAtomic

public final boolean isAtomic()

Description copied from class: IclTerm

Check if this term is atomic--can never have children.

Specified by:

isAtomic in class IclTerm

isComposite

public final boolean isComposite()

Description copied from class: IclTerm

Check if this term is composite--can have children.

Specified by:

isComposite in class IclTerm

toArrayList

public final java.util.ArrayList toArrayList()

Description copied from class: IclTerm

Get the children of this node as an ArrayList. Returns a new, empty ArrayList for nodes without children. For IclTerms that cannot have children, this returns null. You should not alter this ArrayList.

Specified by:

toArrayList in class IclTerm

Returns:

ArrayList the list of children--altering this will alter the internal data structure used by the IclTerm! Don't do it! Use the listIterator() or iterator() methods.

getNumChildren

public final int getNumChildren()

Description copied from class: IclTerm

Get the number of children of this node.

Specified by:

getNumChildren in class IclTerm

Returns:

int: the number of children

add

public final void add(IclTerm n)
               throws java.lang.UnsupportedOperationException

Description copied from class: IclTerm

Add a child to the end of the list of children.

Specified by:

add in class IclTerm

Parameters:

n - the term to add.

java.lang.UnsupportedOperationException

add

public final void add(int index,
                      IclTerm n)
               throws java.lang.UnsupportedOperationException

Description copied from class: IclTerm

Add a child to this term at the given index

Specified by:

add in class IclTerm

Throws:

java.lang.UnsupportedOperationException - if term cannot have children

addAll

public final void addAll(IclTerm l)
                  throws java.lang.UnsupportedOperationException

Description copied from class: IclTerm

Add all the children of the given term to this term. The order in which they are added is the same order in which they are encountered using l.toArrayList().listIterator(). Uses the add(IclTerm) method to actually do the adding.

Specified by:

addAll in class IclTerm

Parameters:

l - the IclTerm containing the children to add.

Throws:

java.lang.UnsupportedOperationException - if term cannot have children

clearTerms

public final void clearTerms()
                      throws java.lang.UnsupportedOperationException

Description copied from class: IclTerm

Remove all children of this node.

Specified by:

clearTerms in class IclTerm

Throws:

java.lang.UnsupportedOperationException - if term cannot have children

getChild

protected final IclTerm getChild(int i)
                          throws java.lang.UnsupportedOperationException

Description copied from class: IclTerm

Get the child at the given Index. Assumes children exists.

Specified by:

getChild in class IclTerm

Returns:

IclTerm: the child at the index

Throws:

java.lang.UnsupportedOperationException - if term cannot have children

getTerm

public final IclTerm getTerm(int i)
                      throws java.lang.UnsupportedOperationException

Description copied from class: IclTerm

Get the term at the given index. For a readonly term, returns a clone.

Specified by:

getTerm in class IclTerm

Parameters:

i - index of term (first term has index 0, and last has index (size() -1)

Returns:

IclTerm: the term, or null if no such child

java.lang.UnsupportedOperationException

size

public final int size()

Description copied from class: IclTerm

Get the number of children of this node.

Specified by:

size in class IclTerm

Returns:

int: the number of children

removeAllUnifying

public final void removeAllUnifying(IclTerm n)
                             throws java.lang.UnsupportedOperationException

Description copied from class: IclTerm

Remove all terms from this term's children for which the given term unifies.

Specified by:

removeAllUnifying in class IclTerm

Parameters:

n - the term against which children must unify to be removed

Throws:

java.lang.UnsupportedOperationException - if term cannot have children

removeUnifying

public final IclTerm removeUnifying(IclTerm n)
                             throws java.lang.UnsupportedOperationException

Description copied from class: IclTerm

Remove the first child found that unifies with the given one.

Specified by:

removeUnifying in class IclTerm

Parameters:

n - the term against which to unify

Returns:

IclTerm: the removed term, or null

Throws:

java.lang.UnsupportedOperationException - if term cannot have children

removeElement

public final void removeElement(int i)
                         throws java.lang.UnsupportedOperationException

Description copied from class: IclTerm

Remove the child at the given index.

Specified by:

removeElement in class IclTerm

Parameters:

i - the index

Throws:

java.lang.UnsupportedOperationException - if term cannot have children

replaceUnifying

public final void replaceUnifying(IclTerm target,
                                  IclTerm replacement)
                           throws java.lang.UnsupportedOperationException

Description copied from class: IclTerm

Replace all terms that unify with target with replacement. Note that we don't use copies of the replacement, but the replacement itself.

Specified by:

replaceUnifying in class IclTerm

Parameters:

target - the target against which to unify

replacement - the replacement

Throws:

java.lang.UnsupportedOperationException - if term cannot have children

replaceElement

public final void replaceElement(int target,
                                 IclTerm replacement)
                          throws java.lang.IndexOutOfBoundsException,
                                 java.lang.UnsupportedOperationException

Description copied from class: IclTerm

Replace the term at the given index. If there is no child at the given index, nothing happens. Again, no copies of the replacement are used.

Specified by:

replaceElement in class IclTerm

Parameters:

target - the index to replace

replacement - the replacement

Throws:

java.lang.IndexOutOfBoundsException - if target is out of bounds

java.lang.UnsupportedOperationException

iterator

public final java.util.Iterator iterator()
                                  throws java.lang.UnsupportedOperationException

Description copied from class: IclTerm

Get an iterator for the children of this term. If no iterator is possible for this type of term, returns an empty Iterator that cannot be modified. If there are no children, but children are possible, then return an empty Iterator. All optional methods of the Iterator interface are implemented if the term is composite.

Specified by:

iterator in class IclTerm

Returns:

Iterator an iterator over the children of this term

java.lang.UnsupportedOperationException

See Also:

IclTerm.isAtomic(), IclTerm.isComposite()

listIterator

public java.util.ListIterator listIterator()
                                    throws java.lang.UnsupportedOperationException

Description copied from class: IclTerm

Get an iterator for the children of this term. If no iterator is possible for this type of term, returns an empty ListIterator that cannot be modified. If there are no children, but children are possible, then return an empty Iterator. All optional methods of the ListIterator interface are implemented if the term is composite.

Specified by:

listIterator in class IclTerm

Returns:

ListIterator, an iterator over the children of this term

java.lang.UnsupportedOperationException

See Also:

IclTerm.isAtomic(), IclTerm.isComposite()

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object