Interface PsyIndexed<K extends PsyObject,V extends PsyObject>

Type Parameters:
K - a type of keys or indices.
V - a type of elements.
All Superinterfaces:
PsyConvertableToName, PsyConvertableToString, PsyObject
All Known Subinterfaces:
PsyFormalArray<T>, PsyFormalDict<V>
All Known Implementing Classes:
PsyArray, PsyBitArray, PsyConfigDict, PsyDict, PsyErrorDict, PsyModule, PsyNamespace, PsyProc, PsyRomanNumerals, PsyString, PsySystemDict

public interface PsyIndexed<K extends PsyObject,V extends PsyObject> extends PsyObject
A representation of indexed, a type of the container whose elements are indexed.
  • Field Details

  • Method Details

    • psyKnown

      PsyBoolean psyKnown(K oKey)
      Returns a boolean indicating whether given key or index exists in this object.
      Parameters:
      oKey - a key or an index.
      Returns:
      a result.
    • psyGet

      V psyGet(K oKey) throws PsyErrorException
      Returns the element with given key or index.
      Parameters:
      oKey - a key or an index.
      Returns:
      an element.
      Throws:
      PsyErrorException - when index is out of range.
    • psyPut

      void psyPut(K oKey, V oValue) throws PsyErrorException
      Stores an element with given key or index. In PsyFormalArray containers replaces existing element. In PsyFormalDict containers replaces an old or creates a new element associated with specified key.
      Parameters:
      oKey - a key or an index.
      oValue - an element to be stored.
      Throws:
      PsyErrorException - when key is absent or index is out of range.
    • psyDelete

      void psyDelete(K oKey) throws PsyErrorException
      Deletes a key or index and a value associated with it from this object.
      Parameters:
      oKey - a key or an index.
      Throws:
      PsyErrorException - when key is absent or index is out of range.
    • psyExtract

      V psyExtract(K oKey) throws PsyErrorException
      Throws:
      PsyErrorException
    • psySlice

      PsyIndexed<K,V> psySlice(PsyIterable<K> oKeys) throws PsyErrorException
      Returns a container of the same type as this object consisting of keys or indices from given iterable and of associated values.
      Parameters:
      oKeys - an enumeration of keys.
      Returns:
      a container.
      Throws:
      PsyErrorException - when key is absent or index is out of range.
    • psyGetAll

      PsyFormalArray<V> psyGetAll(PsyIterable<K> oKeys) throws PsyErrorException
      Throws:
      PsyErrorException
    • psyKeys

      PsyFormalStream<K> psyKeys()
      Returns an iterable enumeration of all the keys of this object.
      Returns:
      an enumeration of keys.
    • psyValues

      default PsyFormalStream<V> psyValues()
      Returns an iterable enumeration of all the values of this object.
      Returns:
      an enumeration of values.
    • psyEntries

      PsyFormalStream<PsyObject> psyEntries()
      Returns an iterable enumeration of all the keys and values of this object.
      Returns:
      an enumeration of entries.