Package de.aristaflow.adept2.model.datamanagement

Class PlaceholderValue.PlaceholderUdtValue

java.lang.Object
de.aristaflow.adept2.model.datamanagement.PlaceholderValue.AbstractPlaceholderValue
de.aristaflow.adept2.model.datamanagement.PlaceholderValue.PlaceholderUdtValue
All Implemented Interfaces:
PlaceholderValue, UDTValue, TypedCloneable<PlaceholderValue.PlaceholderUdtValue>, Closeable, Serializable, AutoCloseable, Cloneable
Enclosing interface:
PlaceholderValue
public static final class PlaceholderValue.PlaceholderUdtValue extends PlaceholderValue.AbstractPlaceholderValue implements UDTValue, TypedCloneable<PlaceholderValue.PlaceholderUdtValue>
This class implements the PlaceholderValue for a value of ProcessConstants.AdeptDataType.USERDEFINED type.
See Also:

  • Method Details

    • getUserDefinedType

      public String getUserDefinedType()
      Description copied from interface: UDTValue
      Gets the name (a string) of the user-defined type of this value.
      Specified by:
      getUserDefinedType in interface UDTValue
      Returns:
      The name of the user-defined data type of this value.

    • getValueAsStream

      public InputStream getValueAsStream()
      Description copied from interface: UDTValue
      Gets the value as an InputStream of this user-defined data type.
      You have to close the stream after usage.
      Specified by:
      getValueAsStream in interface UDTValue
      Returns:
      The value of a (this) user-defined data type as an InputStream. The caller is responsible for closing.

    • getInputStream

      public InputStream getInputStream()
      Description copied from interface: UDTValue
      Gets the value as an InputStream of this user-defined data type.
      You have to close the stream after usage. Usually you should not UDTValue.close() this UDTValue before all created input streams have been consumed. Implementations may deviate so that closing the UDTValue does not affect the created input streams.
      Specified by:
      getInputStream in interface UDTValue
      Returns:
      The value of a (this) user-defined data type as an InputStream. The caller is responsible for closing.

    • getValueAsArray

      public byte[] getValueAsArray()
      Description copied from interface: UDTValue
      Gets the value as a byte array of this user-defined data type.
      Specified by:
      getValueAsArray in interface UDTValue
      Returns:
      The value of a (this) user-defined data type as an array of bytes.

    • getSize

      public Long getSize()
      Description copied from interface: UDTValue
      Gets the size of this UDT value if it is known. For instance, if the content stems from a stream and the stream is not read yet, the size cannot be determined and null will be returned.
      Specified by:
      getSize in interface UDTValue
      Returns:
      The size of the content of this UDT value, null if the content is not known yet, for instance, it has not been read from the input stream yet.

    • getBytes

      public byte[] getBytes()
      Description copied from interface: UDTValue
      Gets the value as a byte array of this user-defined data type.
      Specified by:
      getBytes in interface UDTValue
      Returns:
      The value of a (this) user-defined data type as an array of bytes.

    • close

      public void close()
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable
      Specified by:
      close in interface UDTValue

    • clone

      public PlaceholderValue.PlaceholderUdtValue clone()
      Description copied from interface: UDTValue
      Clones this UDTValue in case it is Cloneable, otherwise a CloneNotSupportedException will be thrown (which is what this default implementation does). Subclasses should provide a corresponding implementation and also extend Cloneable. Those which do not, should forward to this default implementation.
      Specified by:
      clone in interface TypedCloneable<PlaceholderValue.PlaceholderUdtValue>
      Specified by:
      clone in interface UDTValue
      Overrides:
      clone in class Object
      Returns:
      A clone of this UDTValue instance.