li.cil.oc.api.prefab

Class AbstractValue

java.lang.Object

li.cil.oc.api.prefab.AbstractValue

All Implemented Interfaces:

Value, Persistable

public class AbstractValue
extends java.lang.Object
implements Value

Basic implementation for the Value interface.

Constructor Summary

Constructors

Constructor and Description
AbstractValue()

Method Summary

Modifier and Type	Method and Description
java.lang.Object	apply(Context context, Arguments arguments) This is called when the code running on a machine tries to index this value.
java.lang.Object[]	call(Context context, Arguments arguments) This is called when the code running on a machine tries to call this value as a function.
void	dispose(Context context) This is called when the object's representation in the machine it was pushed to is garbage collected.
void	load(net.minecraft.nbt.NBTTagCompound nbt) Restores a previous state of the object from the specified NBT tag.
void	save(net.minecraft.nbt.NBTTagCompound nbt) Saves the current state of the object into the specified NBT tag.
void	unapply(Context context, Arguments arguments) This is called when the code running on a machine tries to assign a new value at the specified index of this value.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractValue

public AbstractValue()

Method Detail

apply

public java.lang.Object apply(Context context,
                              Arguments arguments)

Description copied from interface: Value

This is called when the code running on a machine tries to index this value.

Specified by:

apply in interface Value

Parameters:

context - the context from which the method is called, usually the instance of the computer running the script that made the call.

arguments - the arguments passed to the method.

Returns:

the current value at the specified index, or null.

unapply

public void unapply(Context context,
                    Arguments arguments)

Description copied from interface: Value

This is called when the code running on a machine tries to assign a new value at the specified index of this value.

Does nothing if the value is not indexable.

Specified by:

unapply in interface Value

Parameters:

context - the context from which the method is called, usually the instance of the computer running the script that made the call.

arguments - the arguments passed to the method.

call

public java.lang.Object[] call(Context context,
                               Arguments arguments)

Description copied from interface: Value

This is called when the code running on a machine tries to call this value as a function.

If this value is not callable, throws an exception.

Specified by:

call in interface Value

Parameters:

context - the context from which the method is called, usually the instance of the computer running the script that made the call.

arguments - the arguments passed to the method.

Returns:

the result of the call.

dispose

public void dispose(Context context)

Description copied from interface: Value

This is called when the object's representation in the machine it was pushed to is garbage collected.

Important: be aware of the consequences of pushing the same object to multiple machines. You should usually not do that, but if you do, realize this method may be called by either machine.

Specified by:

dispose in interface Value

Parameters:

context - the context from which the method is called, usually the instance of the computer running the script that just garbage collected the object.

load

public void load(net.minecraft.nbt.NBTTagCompound nbt)

Description copied from interface: Persistable

Restores a previous state of the object from the specified NBT tag.

Specified by:

load in interface Persistable

Parameters:

nbt - the tag to read the state from.

save

public void save(net.minecraft.nbt.NBTTagCompound nbt)

Description copied from interface: Persistable

Saves the current state of the object into the specified NBT tag.

This should write the state in such a way that it can be restored when Persistable.load(net.minecraft.nbt.NBTTagCompound) is called with that tag.

Specified by:

save in interface Persistable

Parameters:

nbt - the tag to save the state to.