TAction

java.lang.Object
- com.tameif.tame.element.TAction

All Implemented Interfaces:

Saveable, java.lang.Comparable<TAction>
```
public class TAction
extends java.lang.Object
implements java.lang.Comparable<TAction>, Saveable
```
This is a player-activated action.

Author:

Matthew Tropiano

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class TAction.Type
The action type.

Nested Classes
Modifier and Type	Class and Description
`static class`	`TAction.Type` The action type.

Constructor Summary

Constructors
Constructor and Description

TAction(java.lang.String identity)
Makes a blank action.

Constructors
Constructor and Description
`TAction(java.lang.String identity)` Makes a blank action.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addExtraStrings(java.lang.String extraString)` Adds an extra string.
`void`	`addName(java.lang.String name)` Adds an action name.
`int`	`compareTo(TAction action)`
`boolean`	`containsExtraString(java.lang.String extraString)` Checks if this action contains this extra string, case-insensitively.
`boolean`	`containsName(java.lang.String name)` Checks if this action contains this name, case-insensitively.
`static TAction`	`create(java.io.InputStream in)` Creates this object from an input stream, expecting its byte representation.
`boolean`	`equals(TAction action)` Compares actions.
`boolean`	`equals(java.lang.Object object)`
`void`	`fromBytes(byte[] data)` Reads this object's representation from a byte array.
`java.lang.Iterable<java.lang.String>`	`getExtraStrings()` Gets this action's extra strings.
`java.lang.String`	`getIdentity()` Gets the identity (primary identifier name).
`java.lang.Iterable<java.lang.String>`	`getNames()` Gets the names of this action.
`TAction.Type`	`getType()` Gets the action type.
`int`	`hashCode()`
`boolean`	`isReversed()` Checks if this reverses the context of a strict ditransitive action.
`boolean`	`isStrict()` Checks if this action is strict.
`void`	`readBytes(java.io.InputStream in)` Imports this object from bytes.
`void`	`setReversed(boolean reversed)` Sets if this reverses the context of a strict ditransitive action.
`void`	`setStrict(boolean strict)` Sets if this action is strict.
`void`	`setType(TAction.Type type)` Sets the action type.
`byte[]`	`toBytes()` Gets this object's representation as bytes.
`java.lang.String`	`toString()`
`void`	`writeBytes(java.io.OutputStream out)` Exports this object to bytes.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - TAction
```
public TAction(java.lang.String identity)
```
    Makes a blank action.
    
    Parameters:
    
    identity - this action's identity.
    
    Throws:
    
    java.lang.IllegalArgumentException - if identity is blank.
- Method Detail
  - getIdentity
```
public java.lang.String getIdentity()
```
    Gets the identity (primary identifier name).
    
    Returns:
    
    this action's unique identity.
  - getType
```
public TAction.Type getType()
```
    Gets the action type.
    
    Returns:
    
    the action type.
  - setType
```
public void setType(TAction.Type type)
```
    Sets the action type.
    
    Parameters:
    
    type - the action type.
    
    Throws:
    
    java.lang.IllegalArgumentException - if type is null.
  - isStrict
```
public boolean isStrict()
```
    Checks if this action is strict. Interpreter (and execution logic) changes if this is set:
    - For OPEN, nothing is different.
    - For GENERAL, all input after the accepted verb is considered malformed.
    - For MODAL, all input after the accepted verb and mode is considered malformed.
    - For TRANSITIVE, all input after the accepted verb and object is considered malformed.
    - For DITRANSITIVE, all input after the accepted verb, objects, and conjugates is considered malformed, and the order of the interpreted objects affect what onActionWith blocks are taken.
    Returns:
    
    true if restricted, false if not.
  - setStrict
```
public void setStrict(boolean strict)
```
    Sets if this action is strict.
    
    Parameters:
    
    strict - true if strict, false if not.
  - isReversed
```
public boolean isReversed()
```
    Checks if this reverses the context of a strict ditransitive action.
    
    Returns:
    
    true if so, false if not.
  - setReversed
```
public void setReversed(boolean reversed)
```
    Sets if this reverses the context of a strict ditransitive action.
    
    Parameters:
    
    reversed - true if so, false if not.
  - addName
```
public void addName(java.lang.String name)
```
    Adds an action name. This name is a parseable name via the interpreter that resolves to this action. Extra whitespace between this name are replaced with spaces.
    
    Parameters:
    
    name - the name to add.
  - containsName
```
public boolean containsName(java.lang.String name)
```
    Checks if this action contains this name, case-insensitively. Keep in mind extra whitespace between names are replaced with spaces.
    
    Parameters:
    
    name - the name to check for.
    
    Returns:
    
    true if so, false if not.
  - getNames
```
public java.lang.Iterable<java.lang.String> getNames()
```
    Gets the names of this action.
    
    Returns:
    
    an iterable structure for the names.
  - addExtraStrings
```
public void addExtraStrings(java.lang.String extraString)
```
    Adds an extra string. This parseable string (via interpreter) can be a conjugate or mode, depending on the action type. Extra whitespace between these words are replaced with spaces.
    
    Parameters:
    
    extraString - the string to add.
  - containsExtraString
```
public boolean containsExtraString(java.lang.String extraString)
```
    Checks if this action contains this extra string, case-insensitively. Keep in mind extra whitespace between extra strings are replaced with spaces.
    
    Parameters:
    
    extraString - the string to check for.
    
    Returns:
    
    true if so, false if not.
  - getExtraStrings
```
public java.lang.Iterable<java.lang.String> getExtraStrings()
```
    Gets this action's extra strings.
    
    Returns:
    
    an iterable structure for the extra strings.
  - compareTo
```
public int compareTo(TAction action)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<TAction>
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object object)
```
    Overrides:
    
    equals in class java.lang.Object
  - equals
```
public boolean equals(TAction action)
```
    Compares actions. Uses identity.
    
    Parameters:
    
    action - the other action.
    
    Returns:
    
    true if equal, false if not.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - create
```
public static TAction create(java.io.InputStream in)
                      throws java.io.IOException
```
    Creates this object from an input stream, expecting its byte representation.
    
    Parameters:
    
    in - the input stream to read from.
    
    Returns:
    
    the read object.
    
    Throws:
    
    java.io.IOException - if a read error occurs.
  - writeBytes
```
public void writeBytes(java.io.OutputStream out)
                throws java.io.IOException
```
    Description copied from interface: Saveable
    
    Exports this object to bytes.
    
    Specified by:
    
    writeBytes in interface Saveable
    
    Parameters:
    
    out - the output stream to write to.
    
    Throws:
    
    java.io.IOException - if a write problem occurs.
  - readBytes
```
public void readBytes(java.io.InputStream in)
               throws java.io.IOException
```
    Description copied from interface: Saveable
    
    Imports this object from bytes.
    
    Specified by:
    
    readBytes in interface Saveable
    
    Parameters:
    
    in - the input stream to read from.
    
    Throws:
    
    java.io.IOException - if a read problem occurs.
  - toBytes
```
public byte[] toBytes()
               throws java.io.IOException
```
    Description copied from interface: Saveable
    
    Gets this object's representation as bytes.
    
    Specified by:
    
    toBytes in interface Saveable
    
    Returns:
    
    the byte array of state bytes.
    
    Throws:
    
    java.io.IOException - if a write problem occurs.
  - fromBytes
```
public void fromBytes(byte[] data)
               throws java.io.IOException
```
    Description copied from interface: Saveable
    
    Reads this object's representation from a byte array.
    
    Specified by:
    
    fromBytes in interface Saveable
    
    Parameters:
    
    data - the data to read.
    
    Throws:
    
    java.io.IOException - if a read problem occurs.

Class TAction

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TAction

Method Detail

getIdentity

getType

setType

isStrict

setStrict

isReversed

setReversed

addName

containsName

getNames

addExtraStrings

containsExtraString

getExtraStrings

compareTo

hashCode

equals

equals

toString

create

writeBytes

readBytes

toBytes

fromBytes