Class ByteArray

All Implemented Interfaces:
Cloneable, Iterable<Byte>, ByteArrayFS, CommonArrayFS<Byte>, FeatureStructure, ByteArrayFSImpl, FeatureStructureImpl, CommonPrimitiveArray<Byte>

public final class ByteArray extends TOP implements CommonPrimitiveArray<Byte>, ByteArrayFSImpl, Iterable<Byte>
JCas class model for ByteArray
  • Field Details

    • _TypeName

      public static final String _TypeName
      See Also:
    • typeIndexID

      public static final int typeIndexID
      Each cover class when loaded sets an index. Used in the JCas typeArray to go from the cover class or class instance to the corresponding instance of the _Type class
    • type

      public static final int type
  • Constructor Details

    • ByteArray

      public ByteArray(JCas jcas, int length)
      Make a new ByteArray of given size
      Parameters:
      jcas - the JCas
      length - the length of the array in bytes
    • ByteArray

      public ByteArray(TypeImpl t, CASImpl c, int length)
      used by generator Make a new ByteArray of given size
      Parameters:
      c - -
      t - -
      length - the length of the array in bytes
  • Method Details

    • getTypeIndexID

      public int getTypeIndexID()
      used to obtain reference to the _Type instance
      Overrides:
      getTypeIndexID in class TOP
      Returns:
      the type array index
    • get

      public byte get(int i)
      Description copied from interface: ByteArrayFS
      Get the i-th string from the array.
      Specified by:
      get in interface ByteArrayFS
      Parameters:
      i - the index
      Returns:
      The i-th element.
      See Also:
    • set

      public void set(int i, byte v)
      Description copied from interface: ByteArrayFS
      Set the i-th value.
      Specified by:
      set in interface ByteArrayFS
      Parameters:
      i - The index.
      v - The value.
      See Also:
    • copyFromArray

      public void copyFromArray(byte[] src, int srcPos, int destPos, int length)
      Description copied from interface: ByteArrayFS
      Copy the contents of an external array into this array.
      Specified by:
      copyFromArray in interface ByteArrayFS
      Parameters:
      src - The source array.
      srcPos - Where to start copying in the source array.
      destPos - Where to start copying to in the destination array.
      length - The number of elements to copy.
      See Also:
    • copyToArray

      public void copyToArray(int srcPos, byte[] dest, int destPos, int length)
      Description copied from interface: ByteArrayFS
      Copy the contents of the array from start to end to the destination destArray with destination offset destOffset.
      Specified by:
      copyToArray in interface ByteArrayFS
      Parameters:
      srcPos - The index of the first element to copy.
      dest - The array to copy to.
      destPos - Where to start copying into dest.
      length - The number of elements to copy.
      See Also:
    • toArray

      public byte[] toArray()
      Description copied from interface: ByteArrayFS
      Create a Java array that is a copy of the internal CAS array.
      Specified by:
      toArray in interface ByteArrayFS
      Returns:
      An array copy.
      See Also:
    • size

      public int size()
      return the size of the array
      Specified by:
      size in interface CommonArrayFS<Byte>
      Returns:
      The size of the array.
    • copyToArray

      public void copyToArray(int srcPos, String[] dest, int destPos, int length)
      Description copied from interface: CommonArrayFS
      Copy the contents of the array to an external string array.
      Specified by:
      copyToArray in interface CommonArrayFS<Byte>
      Parameters:
      srcPos - The index of the first element to copy.
      dest - The array to copy to.
      destPos - Where to start copying into dest.
      length - The number of elements to copy.
      See Also:
    • copyFromArray

      public void copyFromArray(String[] src, int srcPos, int destPos, int length)
      Description copied from interface: CommonArrayFS
      Copy the contents of an external string array into this array. The strings are parsed and converted to floats.
      Specified by:
      copyFromArray in interface CommonArrayFS<Byte>
      Parameters:
      src - The source array.
      srcPos - Where to start copying in the source array.
      destPos - Where to start copying to in the destination array.
      length - The number of elements to copy.
      See Also:
    • _getTheArray

      public byte[] _getTheArray()
    • copyValuesFrom

      public void copyValuesFrom(CommonArrayFS<Byte> v)
      Description copied from interface: CommonArrayFS
      Copy values from another array of the same kind
      Specified by:
      copyValuesFrom in interface CommonArrayFS<Byte>
      Parameters:
      v - the other array
    • setArrayValueFromString

      public void setArrayValueFromString(int i, String v)
      Description copied from interface: CommonPrimitiveArray
      Internal Use Only. Set an array value from a string representation NOTE: does **not** log the change for delta cas; this should only be used by internal deserializers
      Specified by:
      setArrayValueFromString in interface CommonPrimitiveArray<Byte>
      Parameters:
      i - the index
      v - the value to set at the above index
    • iterator

      public Iterator<Byte> iterator()
      Specified by:
      iterator in interface Iterable<Byte>
    • create

      public static ByteArray create(JCas jcas, byte[] a)
      Parameters:
      jcas - Which CAS to create the array in
      a - the source for the array's initial values
      Returns:
      a newly created and populated array
    • contains

      public boolean contains(byte item)
      Parameters:
      item - the item to see if is in the array
      Returns:
      true if the item is in the array