Package com.blackrook.rookscript.resolvers.variable

Class ObjectVariableResolver<T>

java.lang.Object
com.blackrook.rookscript.resolvers.variable.ObjectVariableResolver<T>
Type Parameters:
T - the object type.
All Implemented Interfaces:
ScriptVariableResolver
public class ObjectVariableResolver<T> extends Object implements ScriptVariableResolver
A variable resolver that wraps an object instance's fields and getters/setters as a scope. The "field names" of the fields/methods are used as the variable names.
Author:
Matthew Tropiano

  • Constructor Details

    • ObjectVariableResolver

      public ObjectVariableResolver(T instance)
      Creates a new resolver for this object.
      Parameters:
      instance - the object instance to wrap.

  • Method Details

    • getInstance

      public T getInstance()
      Returns:
      the wrapped instance.

    • getValue

      public boolean getValue(String name, ScriptValue out)
      Description copied from interface: ScriptVariableResolver
      Gets the corresponding value for a variable name. Changing the returned value does not change the value, unless it is a reference type like a map or list.
      Specified by:
      getValue in interface ScriptVariableResolver
      Parameters:
      name - the variable name.
      out - the destination variable for the value.
      Returns:
      true if a corresponding value was fetched into out, false if not. If false, out is set to the null value.

    • setValue

      public void setValue(String name, ScriptValue value)
      Description copied from interface: ScriptVariableResolver
      Sets a key-value pair. This should fail if the provided name corresponds to a read-only variable.
      Specified by:
      setValue in interface ScriptVariableResolver
      Parameters:
      name - the variable name.
      value - the corresponding value.
      See Also:

    • containsValue

      public boolean containsValue(String name)
      Description copied from interface: ScriptVariableResolver
      Checks if this contains a value by its variable name.
      Specified by:
      containsValue in interface ScriptVariableResolver
      Parameters:
      name - the variable name.
      Returns:
      true if so, false if not.

    • isReadOnly

      public boolean isReadOnly(String name)
      Description copied from interface: ScriptVariableResolver
      Checks if an existing value is read-only.
      Specified by:
      isReadOnly in interface ScriptVariableResolver
      Parameters:
      name - the variable name.
      Returns:
      true if so, false if not.

    • isEmpty

      public boolean isEmpty()
      Description copied from interface: ScriptVariableResolver
      Checks if this resolver maintains no values.
      Specified by:
      isEmpty in interface ScriptVariableResolver
      Returns:
      true if so, false if not.

    • size

      public int size()
      Specified by:
      size in interface ScriptVariableResolver
      Returns:
      the amount of values that this maintains.