net.sf.freecol.server.control

Class ChangeSet.See

java.lang.Object

net.sf.freecol.server.control.ChangeSet.See

Enclosing class:

ChangeSet

public static class ChangeSet.See
extends java.lang.Object

Class to control the visibility of a change.

Field Summary

Fields

Modifier and Type	Field and Description
private static int	ALL
private static int	ONLY
private static int	PERHAPS
private ServerPlayer	seeAlways
private ServerPlayer	seeNever
private ServerPlayer	seePerhaps
private int	type

Constructor Summary

Constructors

Modifier	Constructor and Description
private	See(int type)

Method Summary

Modifier and Type	Method and Description
static ChangeSet.See	all() Make this change visible to all players.
ChangeSet.See	always(ServerPlayer player) Make this change visible to the given player.
boolean	check(ServerPlayer player, boolean perhapsResult) Check this visibility with respect to a player.
ChangeSet.See	except(ServerPlayer player) Make this change invisible to the given player.
static ChangeSet.See	only(ServerPlayer player) Make this change visible only to the given player.
static ChangeSet.See	perhaps() Make this change visible to all players, provided they can see the objects that are being changed.
ChangeSet.See	perhaps(ServerPlayer player) Make this change visible to the given player, provided the player can see the objects being changed.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

ALL

private static final int ALL

See Also:

Constant Field Values

PERHAPS

private static final int PERHAPS

See Also:

Constant Field Values

ONLY

private static final int ONLY

See Also:

Constant Field Values

seeAlways

private ServerPlayer seeAlways

seePerhaps

private ServerPlayer seePerhaps

seeNever

private ServerPlayer seeNever

type

private final int type

Constructor Detail

See

private See(int type)

Method Detail

check

public boolean check(ServerPlayer player,
                     boolean perhapsResult)

Check this visibility with respect to a player.

Parameters:

player - The ServerPlayer to consider.

perhapsResult - The result if the visibility is ambiguous.

Returns:

True if the player satisfies the visibility test.

all

public static ChangeSet.See all()

Make this change visible to all players.

Returns:

a See value

perhaps

public static ChangeSet.See perhaps()

Make this change visible to all players, provided they can see the objects that are being changed.

Returns:

a See value

only

public static ChangeSet.See only(ServerPlayer player)

Make this change visible only to the given player.

Parameters:

player - a ServerPlayer value

Returns:

a See value

always

public ChangeSet.See always(ServerPlayer player)

Make this change visible to the given player.

Parameters:

player - a ServerPlayer value

Returns:

a See value

perhaps

public ChangeSet.See perhaps(ServerPlayer player)

Make this change visible to the given player, provided the player can see the objects being changed.

Parameters:

player - a ServerPlayer value

Returns:

a See value

except

public ChangeSet.See except(ServerPlayer player)

Make this change invisible to the given player.

Parameters:

player - a ServerPlayer value

Returns:

a See value

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object