org.youscope.clientinterfaces

Enum FramePositionStorageType

java.lang.Object

java.lang.Enum<FramePositionStorageType>

org.youscope.clientinterfaces.FramePositionStorageType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<FramePositionStorageType>

public enum FramePositionStorageType
extends java.lang.Enum<FramePositionStorageType>

Enum defining how frame positions should be stored.

Author:

Moritz Lang

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL Store window positions
NONE Do not store window positions.
READ_ONLY Do not store new, but apply existing positions.
READ_UPDATE Do not store new, but apply and update existing positions.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.String identifier) True if the identifier refers to this frame position storage type.
java.lang.String	getDescription() Returns a short human readable description of this storage type.
java.lang.String	getIdentifier() Returns the identifier of this storage type.
static FramePositionStorageType	getType(java.lang.String identifier) Returns the storage type corresponding to the identifier.
boolean	isPositionFrames() True if the position of frames should be set to the last position.
boolean	isReadDisk() True if frame positions should be read from a position config file at startup.
boolean	isStoreNewPositions() True if positions of frames for which yet no position is stored, should be stored.
boolean	isUpdatePositions() True if existing frame positions should be updated when user moves frames around.
boolean	isWriteDisk() True if frame positions should be stored in a config file upon shutdown.
java.lang.String	toString()
static FramePositionStorageType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static FramePositionStorageType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final FramePositionStorageType NONE

Do not store window positions.

ALL

public static final FramePositionStorageType ALL

Store window positions

READ_ONLY

public static final FramePositionStorageType READ_ONLY

Do not store new, but apply existing positions.

READ_UPDATE

public static final FramePositionStorageType READ_UPDATE

Do not store new, but apply and update existing positions.

Method Detail

values

public static FramePositionStorageType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (FramePositionStorageType c : FramePositionStorageType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static FramePositionStorageType valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

isPositionFrames

public boolean isPositionFrames()

True if the position of frames should be set to the last position.

Returns:

True if newly created frames should be set to their previous position.

isReadDisk

public boolean isReadDisk()

True if frame positions should be read from a position config file at startup.

Returns:

True to read positions on startup.

isWriteDisk

public boolean isWriteDisk()

True if frame positions should be stored in a config file upon shutdown.

Returns:

True if frame positions should be stored.

isUpdatePositions

public boolean isUpdatePositions()

True if existing frame positions should be updated when user moves frames around.

Returns:

true if positions get updated.

isStoreNewPositions

public boolean isStoreNewPositions()

True if positions of frames for which yet no position is stored, should be stored.

Returns:

True to add new frame positions.

equals

public boolean equals(java.lang.String identifier)

True if the identifier refers to this frame position storage type.

Parameters:

identifier - identifier of storage type.

Returns:

true if identifier refers to this storage type.

getIdentifier

public java.lang.String getIdentifier()

Returns the identifier of this storage type.

Returns:

identifier of this storage type. See YouScopeProperties.setProperty(String, String).

getDescription

public java.lang.String getDescription()

Returns a short human readable description of this storage type.

Returns:

Short human readable description.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<FramePositionStorageType>

getType

public static FramePositionStorageType getType(java.lang.String identifier)

Returns the storage type corresponding to the identifier. If the identifier is null or unknown, returns NONE.

Parameters:

identifier - Identifier of storage type.

Returns:

The frame position storage type having the identifier, or NONE if unknown identifier.