Package com.planet_ink.coffee_mud.Common.interfaces

Class ScriptingEngine.SubScript

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<ScriptingEngine.ScriptLn>

com.planet_ink.coffee_mud.Common.interfaces.ScriptingEngine.SubScript

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<ScriptingEngine.ScriptLn>, java.util.Collection<ScriptingEngine.ScriptLn>, java.util.List<ScriptingEngine.ScriptLn>, java.util.RandomAccess

Enclosing interface:

ScriptingEngine

public abstract static class ScriptingEngine.SubScript
extends java.util.ArrayList<ScriptingEngine.ScriptLn>

Wrapper class for a subscript, which consists of a trigger and its requisite code.

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor	Description
SubScript()

Method Summary

Modifier and Type	Method	Description
abstract java.lang.String[]	getTriggerArgs()	Returns the trigger args for this entire script
abstract java.lang.String[]	getTriggerBits()	The cleaned bits of the trigger, uppercased.
abstract int	getTriggerCode()	Returns the trigger code for this entire script
abstract java.lang.String	getTriggerLine()	Returns the trigger line for this entire script The trigger word itself should be normalized to uppercase.

Methods inherited from class java.util.AbstractCollection

containsAll, toString

Methods inherited from class java.util.AbstractList

equals, hashCode

Methods inherited from class java.util.ArrayList

add, add, addAll, addAll, clear, clone, contains, ensureCapacity, forEach, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from interface java.util.Collection

parallelStream, stream

Methods inherited from interface java.util.List

containsAll, equals, hashCode

Methods inherited from class java.lang.Object

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

Constructor Detail

SubScript

public SubScript()

Method Detail

getTriggerCode

public abstract int getTriggerCode()

Returns the trigger code for this entire script

Returns:

the trigger code

getTriggerArgs

public abstract java.lang.String[] getTriggerArgs()

Returns the trigger args for this entire script

Returns:

the trigger args

getTriggerLine

public abstract java.lang.String getTriggerLine()

Returns the trigger line for this entire script The trigger word itself should be normalized to uppercase.

Returns:

the trigger line

getTriggerBits

public abstract java.lang.String[] getTriggerBits()

The cleaned bits of the trigger, uppercased.

Returns:

the cleaned bits of the trigger, uppercased.