Package mgui.interfaces.variables

Class StringVectorInt

java.lang.Object
mgui.interfaces.AbstractInterfaceObject
mgui.interfaces.variables.VariableInt<java.lang.String>
mgui.interfaces.variables.StringVectorInt
All Implemented Interfaces:
AttributeObject, InterfaceObject, NamedObject, TreeObject, CleanableObject, XMLObject, IconObject
public class StringVectorInt
extends VariableInt<java.lang.String>
Stores an array of String objects as a variable.
Since:
1.0
Version:
1.0
Author:
Andrew Reid

  • Field Details

    • elements

      public java.util.ArrayList<java.lang.String> elements

  • Constructor Details

    • StringVectorInt

      public StringVectorInt​(java.lang.String name, int n)

    • StringVectorInt

      public StringVectorInt​(java.util.List<java.lang.String> values)

    • StringVectorInt

      public StringVectorInt​(java.lang.String name, java.util.List<java.lang.String> values)

  • Method Details

    • getAsList

      public java.util.ArrayList<java.lang.String> getAsList()
      Description copied from class: VariableInt
      Returns this variable as a single list of values.
      Specified by:
      getAsList in class VariableInt<java.lang.String>
      Returns:

    • getSize

      public int getSize()
      Description copied from class: VariableInt
      Returns the total size (number of elements) of this variable.
      Specified by:
      getSize in class VariableInt<java.lang.String>
      Returns:

    • getObjectIcon

      public javax.swing.Icon getObjectIcon()
      Description copied from interface: IconObject
      Returns the Icon associated with this object.
      Specified by:
      getObjectIcon in interface IconObject
      Overrides:
      getObjectIcon in class VariableInt<java.lang.String>
      Returns:

    • getValue

      public java.lang.String getValue​(int i) throws VariableException
      Throws:
      VariableException

    • setValue

      public boolean setValue​(java.util.List<java.lang.Integer> indices, java.lang.String value) throws VariableException
      Description copied from class: VariableInt
      Sets the value at the given indices; throws an exception if they are out of bounds, this variable is not editable, or value is an inappropriate value.
      Specified by:
      setValue in class VariableInt<java.lang.String>
      Returns:
      object at the given indices
      Throws:
      VariableException

    • setStringValue

      public boolean setStringValue​(java.util.List<java.lang.Integer> indices, java.lang.String value) throws VariableException
      Description copied from class: VariableInt
      Sets the value at the given indices as a String; throws an exception if they are out of bounds, this variable is not editable, or value is an inappropriate value.
      Specified by:
      setStringValue in class VariableInt<java.lang.String>
      Returns:
      object at the given indices
      Throws:
      VariableException

    • getDimensions

      public java.util.ArrayList<java.lang.Integer> getDimensions()
      Specified by:
      getDimensions in class VariableInt<java.lang.String>

    • getValue

      protected java.lang.String getValue​(java.util.List<java.lang.Integer> indices) throws VariableException
      Description copied from class: VariableInt
      Returns the value at the given indices; throws an exception if they are out of bounds. If the indices are of a lower dimension than the variable dimension, the returned object is handled by the subclass method. As a general policy, this object should represent the remaining dimensions in some way.
      Specified by:
      getValue in class VariableInt<java.lang.String>
      Returns:
      object at the given indices
      Throws:
      VariableException

    • getPart

      public StringVectorInt getPart​(java.lang.String name, int start, int end)
      Returns a part of this vector, between and including indices start and end.
      Parameters:
      name -
      start -
      end -
      Returns:

    • getPart

      public StringVectorInt getPart​(java.lang.String name, java.lang.String part)
      Description copied from class: VariableInt
      Parses part to return a part of this variable. Syntax for n dimensions is: "x_start,y_start,..,n_start:x_start,y_start,..,n_start". E.g., "1,2:20,2". Use asterisk, "*" to indicate last element in a dimension. E.g,, "1,2:*,*".
      Specified by:
      getPart in class VariableInt<java.lang.String>
      Returns:

    • getN

      public int getN()

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class VariableInt<java.lang.String>

    • isNumeric

      public boolean isNumeric()
      Description copied from class: VariableInt
      Determines whether this variable contains numeric values.
      Overrides:
      isNumeric in class VariableInt<java.lang.String>
      Returns:

    • getType

      public java.lang.Class<java.lang.String> getType()
      Description copied from class: VariableInt
      Returns a Class object which is the parameterized type of this variable.
      Overrides:
      getType in class VariableInt<java.lang.String>
      Returns: