org.jamplate.model

Class Frame

java.lang.Object

org.jamplate.model.Frame

public final class Frame
extends java.lang.Object

An isolated part in the memory.

Since:

0.2.0 ~2021.05.23

Version:

0.2.0

Author:

LSafer

Constructor Summary

Constructors

Constructor and Description
Frame() Construct a new frame.
Frame(@NotNull Frame frame) Construct a copy of the given frame.
Frame(@NotNull Instruction instruction) Construct a new frame with the given instruction.

Method Summary

Modifier and Type	Method and Description
Value	compute(@NotNull java.lang.String address, @NotNull java.util.function.UnaryOperator<Value> operator) Replace the value at the given address with the result of invoking the given operator with the current value.
@NotNull Value	get(@NotNull java.lang.String address) Return the value allocated at the given address in this memory.
@Nullable Instruction	getInstruction() Return the instruction of this frame.
@NotNull Value	pop() Return and remove the last pushed value to the stack.
void	push(@NotNull Value value) Push the given value to the stack part of this memory.
void	set(@NotNull java.lang.String address, @NotNull Value value) Set the value at the given address to be the given value.
void	setInstruction(@NotNull Instruction instruction) Set the instruction of this frame to be the given instruction.

Methods inherited from class java.lang.Object

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

Constructor Detail

Frame

public Frame()

Construct a new frame.

Since:

0.2.0 ~2021.05.23

Frame

public Frame(@NotNull
             @NotNull Frame frame)

Construct a copy of the given frame.

Parameters:

frame - the frame to copy.

Throws:

java.lang.NullPointerException - if the given frame is null.

Since:

0.2.0 ~2021.05.23

Frame

public Frame(@NotNull
             @NotNull Instruction instruction)

Construct a new frame with the given instruction.

Parameters:

instruction - the instruction the constructed frame is for.

Throws:

java.lang.NullPointerException - if the given instruction is null.

Since:

0.2.0 ~2021.05.23

Method Detail

compute

@Contract(mutates="this")
public Value compute(@NotNull
                                                @NotNull java.lang.String address,
                                                @NotNull
                                                @NotNull java.util.function.UnaryOperator<Value> operator)

Replace the value at the given address with the result of invoking the given operator with the current value.
If the given operator thrown any exception when invoked by this method. The thrown exception will fall throw this method with nothing changed.

Parameters:

address - the address to replace the value at.

operator - the function to be invoked to acquire the replacement value.

Returns:

the computed value.

Throws:

java.lang.NullPointerException - if the given address or operator is null.

Since:

0.2.0 ~2021.05.23

get

@NotNull
 @Contract(pure=true)
public @NotNull Value get(@NotNull
                                                           @NotNull java.lang.String address)

Return the value allocated at the given address in this memory.

Parameters:

address - the address to be read.

Returns:

the value at the given address. Or Value.NULL if no value was allocated there.

Throws:

java.lang.NullPointerException - if the given address is null.

Since:

0.2.0 ~2021.05.23

getInstruction

@Nullable
 @Contract(pure=true)
public @Nullable Instruction getInstruction()

Return the instruction of this frame.

Returns:

the instruction of this frame.

Since:

0.2.0 ~2021.05.23

pop

@NotNull
 @Contract(mutates="this")
public @NotNull Value pop()

Return and remove the last pushed value to the stack.

Returns:

the last value pushed to the stack. Or Value.NULL if the stack was empty.

Since:

0.2.0 ~2021.05.23

push

@Contract(mutates="this")
public void push(@NotNull
                                            @NotNull Value value)

Push the given value to the stack part of this memory.

Parameters:

value - the value to be pushed.

Throws:

java.lang.NullPointerException - if the given value is null.

Since:

0.2.0 ~2021.05.23

set

@Contract(mutates="this")
public void set(@NotNull
                                           @NotNull java.lang.String address,
                                           @NotNull
                                           @NotNull Value value)

Set the value at the given address to be the given value.

Parameters:

address - the address to set the value to.

value - the value to be set at the given address.

Throws:

java.lang.NullPointerException - if the given address or value is null.

Since:

0.2.0 ~2021.05.23

setInstruction

@Contract(mutates="this")
public void setInstruction(@NotNull
                                                      @NotNull Instruction instruction)

Set the instruction of this frame to be the given instruction.

Parameters:

instruction - the instruction of this frame.

Since:

0.2.0 ~2021.05.23