provided.music

Class NESeqList

java.lang.Object

provided.music.NESeqList

All Implemented Interfaces:

IPhrase, ISeqList

public class NESeqList
extends java.lang.Object
implements ISeqList

A non-empty ("cons") sequence list.

Field Summary

Fields

Modifier and Type	Field and Description
private IPhrase	_first The "first" of the list
private ISeqList	_rest The "rest" of the list
private static IPhraseVisitor	_toStringAlgo toString algo for rest, the recursive helper function of the ToString algo.
static java.lang.String	ID The ID value of this class

Constructor Summary

Constructors

Constructor and Description
NESeqList(IPhrase first, ISeqList rest) Cons an IPhrase to a Sequence List.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	execute(IPhraseVisitor algo, java.lang.Object... params) Calls the NESeqList.ID case of the visitor.
IPhrase	getFirst() Accessor method for the first element
ISeqList	getRest() Accessor method for the rest of the lsit
(package private) static IPhraseVisitor	getToStringAlgo() Getter for the _toStringAlgo helper.
static void	setToStringAlgo(IPhraseVisitor stringAlgo) Setter for the _toStringAlgo helper.
java.lang.String	toString() Run a visitor over the list to convert it to a String.

Methods inherited from class java.lang.Object

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

Field Detail

ID

public static final java.lang.String ID

The ID value of this class

See Also:

Constant Field Values

_first

private IPhrase _first

The "first" of the list

_rest

private ISeqList _rest

The "rest" of the list

_toStringAlgo

private static IPhraseVisitor _toStringAlgo

toString algo for rest, the recursive helper function of the ToString algo.

Constructor Detail

NESeqList

public NESeqList(IPhrase first,
                 ISeqList rest)

Cons an IPhrase to a Sequence List.

Parameters:

first - The first element of the sequence

rest - The rest of the sequence

Method Detail

getFirst

public IPhrase getFirst()

Accessor method for the first element

Returns:

the IPhrase that is the first element of the sequence list

getRest

public ISeqList getRest()

Accessor method for the rest of the lsit

Returns:

the rest of the sequence list

execute

public java.lang.Object execute(IPhraseVisitor algo,
                                java.lang.Object... params)

Calls the NESeqList.ID case of the visitor.

Specified by:

execute in interface IPhrase

Parameters:

algo - The visitor that is being used

params - vararg input parameters for the visitor.

Returns:

the result of running the visitor on this host.

setToStringAlgo

public static void setToStringAlgo(IPhraseVisitor stringAlgo)

Setter for the _toStringAlgo helper. This non-typical method is provided solely for the purpose of enabling the student to install their toStringAlgo into the read-only provided code.

Parameters:

stringAlgo - The helper algo to use.

getToStringAlgo

static IPhraseVisitor getToStringAlgo()

Getter for the _toStringAlgo helper. Only for use internally inside this package so ToggleDecoratorSeqList and FineToggleDecoratorSeqList can use the same visitor.

Returns:

the toStringAlgo helper visitor

toString

public java.lang.String toString()

Run a visitor over the list to convert it to a String. Delegates to the rest of the list using the helper algo, with the accumulator (params[0]) set to "{"+_first.toString().

Overrides:

toString in class java.lang.Object

Returns:

"{a, b, c, d}"