com.xdest.bf

Enum BFFutureCommand

java.lang.Object

java.lang.Enum<BFFutureCommand>

com.xdest.bf.BFFutureCommand

All Implemented Interfaces:

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

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

Similar to BFCommand, but includes higher level commands.

Author:

xDest

Enum Constant Summary

Enum Constants

Enum Constant and Description
COPY_CHUNK_A_TO_B Copy one BFScript.MemoryChunk to another.
DECREMENT Decrement the value at the pointer by one
INCREMENT Increment the value at the pointer by one
INPUT Accept input saved to the currently pointed at position
LOOP_END End a loop.
LOOP_START Start a loop.
MOVE_TO_CHUNK Move to the starting position of a BFScript.MemoryChunk.
PRINT Print out the value at this pointed position
PRINT_CHUNK Print a BFScript.MemoryChunk by moving to it's position and printing each value in it.
SHIFT_DOWN Shift the pointer down one position
SHIFT_UP Shift the pointer up one position

Method Summary

Modifier and Type	Method and Description
BFScript.MemoryChunk	getChunk() Get the chunk used in this command
int	getChunkAddress() Get the memory address of the chunk in this command.
int	getChunkSize() Get the size of the chunk used in this command
BFScript.MemoryChunk	getDestChunk() Get the destination chunk used in this command
int	getDestChunkAddress() Get the memory address of the destination chunk in this command.
int	getDestChunkSize() Get the size of the destination chunk used in this command.
BFFutureCommand	setChunk(BFScript.MemoryChunk c) Set the chunk used in this command.
BFFutureCommand	setDestChunk(BFScript.MemoryChunk c) Set the destination chunk for this command.
static BFFutureCommand	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static BFFutureCommand[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INCREMENT

public static final BFFutureCommand INCREMENT

Increment the value at the pointer by one

DECREMENT

public static final BFFutureCommand DECREMENT

Decrement the value at the pointer by one

SHIFT_UP

public static final BFFutureCommand SHIFT_UP

Shift the pointer up one position

SHIFT_DOWN

public static final BFFutureCommand SHIFT_DOWN

Shift the pointer down one position

INPUT

public static final BFFutureCommand INPUT

Accept input saved to the currently pointed at position

PRINT

public static final BFFutureCommand PRINT

Print out the value at this pointed position

LOOP_START

public static final BFFutureCommand LOOP_START

Start a loop. If the pointed at position is 0, the the program will skip following commands until ']' is reached.

LOOP_END

public static final BFFutureCommand LOOP_END

End a loop. If the pointed at position is 0, the loop will end. Otherwise, the program will return to the last ']'

MOVE_TO_CHUNK

public static final BFFutureCommand MOVE_TO_CHUNK

Move to the starting position of a BFScript.MemoryChunk.

See Also:

BFScript.MemoryChunk

PRINT_CHUNK

public static final BFFutureCommand PRINT_CHUNK

Print a BFScript.MemoryChunk by moving to it's position and printing each value in it.

See Also:

BFScript.MemoryChunk

COPY_CHUNK_A_TO_B

public static final BFFutureCommand COPY_CHUNK_A_TO_B

Copy one BFScript.MemoryChunk to another.

See Also:

BFScript.MemoryChunk

Method Detail

values

public static BFFutureCommand[] 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 (BFFutureCommand c : BFFutureCommand.values())
    System.out.println(c);

Returns:

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

valueOf

public static BFFutureCommand 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

getChunkSize

public int getChunkSize()

Get the size of the chunk used in this command

Returns:

The size, or 0 if there is no chunk.

See Also:

BFScript.MemoryChunk

getDestChunkSize

public int getDestChunkSize()

Get the size of the destination chunk used in this command.

Returns:

The BFScript.MemoryChunk.getSize() of the destination chunk, or 0 if it doesn't exist.

See Also:

BFScript.MemoryChunk

getChunkAddress

public int getChunkAddress()

Get the memory address of the chunk in this command.

Returns:

Memory address, or -1 if there is no chunk

See Also:

BFScript.MemoryChunk

getDestChunkAddress

public int getDestChunkAddress()

Get the memory address of the destination chunk in this command.

Returns:

Memory address, or -1 if there is no chunk

See Also:

BFScript.MemoryChunk

setChunk

public BFFutureCommand setChunk(BFScript.MemoryChunk c)

Set the chunk used in this command. Returns self for method chaining.

Parameters:

c - Chunk used

Returns:

Self

setDestChunk

public BFFutureCommand setDestChunk(BFScript.MemoryChunk c)

Set the destination chunk for this command. Returns self for method chaining.

Parameters:

c - Chunk destination

Returns:

Self

getChunk

public BFScript.MemoryChunk getChunk()

Get the chunk used in this command

Returns:

The chunk

getDestChunk

public BFScript.MemoryChunk getDestChunk()

Get the destination chunk used in this command

Returns:

The chunk