org.starhope.appius.game.npc.plebeian
Class PlebeianTestClause

java.lang.Object
  org.starhope.appius.game.npc.plebeian.PlebeianTestClause

public class PlebeianTestClause
extends Object

a test clause for checking an Action against a scripted proposition

Author:

brpocock@star-hope.org

Field Summary

private String	accusative WRITEME: Document this brpocock@star-hope.org
private String	dative WRITEME: Document this brpocock@star-hope.org
private String	locative WRITEME: Document this brpocock@star-hope.org
private String	nominative WRITEME: Document this brpocock@star-hope.org
private String	verb WRITEME: Document this brpocock@star-hope.org

Constructor Summary

PlebeianTestClause()
construct a neutral test clause that would match anything

PlebeianTestClause(String v, String nom, String acc, String dat, String loc)
construct a test clause with the provided stream of parameters

Method Summary

PlebeianTestClause	addAccusativeProposition(String acc) WRITEME: Document this method brpocock@star-hope.org
PlebeianTestClause	addDativeProposition(String dat) WRITEME: Document this method brpocock@star-hope.org
PlebeianTestClause	addLocativeProposition(String loc) WRITEME: Document this method brpocock@star-hope.org
PlebeianTestClause	addNominativeProposition(String nom) WRITEME: Document this method brpocock@star-hope.org
PlebeianTestClause	addVerbProposition(String v) add a verb proposition to this test clause
String	getAccusative()
String	getDative()
String	getLocative()
String	getNominative()
String	getVerb()
boolean	matches(Action a, AbstractUser whoAmI) determine whether this test clause matches a given action
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

accusative

private final String accusative

WRITEME: Document this brpocock@star-hope.org

dative

private final String dative

WRITEME: Document this brpocock@star-hope.org

locative

private final String locative

WRITEME: Document this brpocock@star-hope.org

nominative

private final String nominative

WRITEME: Document this brpocock@star-hope.org

verb

private final String verb

WRITEME: Document this brpocock@star-hope.org

Constructor Detail

PlebeianTestClause

public PlebeianTestClause()

construct a neutral test clause that would match anything

PlebeianTestClause

public PlebeianTestClause(String v,
                          String nom,
                          String acc,
                          String dat,
                          String loc)

construct a test clause with the provided stream of parameters

Parameters:

v - WRITEME

nom - WRITEME

acc - WRITEME

dat - WRITEME

loc - WRITEME

Method Detail

addAccusativeProposition

public PlebeianTestClause addAccusativeProposition(String acc)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

acc - WRITEME

Returns:

WRITEME

addDativeProposition

public PlebeianTestClause addDativeProposition(String dat)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

dat - WRITEME

Returns:

WRITEME

addLocativeProposition

public PlebeianTestClause addLocativeProposition(String loc)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

loc - WRITEME

Returns:

WRITEME

addNominativeProposition

public PlebeianTestClause addNominativeProposition(String nom)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

nom - WRITEME

Returns:

WRITEME

addVerbProposition

public PlebeianTestClause addVerbProposition(String v)

add a verb proposition to this test clause

Parameters:

v - verb

Returns:

test clause based upon this one with the verb proposition added

getAccusative

public String getAccusative()

Returns:

the accusative

getDative

public String getDative()

Returns:

the dative

getLocative

public String getLocative()

Returns:

the locative

getNominative

public String getNominative()

Returns:

the nominative

getVerb

public String getVerb()

Returns:

the verb

matches

public boolean matches(Action a,
                       AbstractUser whoAmI)

determine whether this test clause matches a given action

Parameters:

a - some action

whoAmI - WRITEME

Returns:

true, if the test clause matches a given action

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()