Package com.inductiveautomation.rm.base

Class RMKeyList

  • All Implemented Interfaces:
    java.lang.Iterable, java.util.Collection, java.util.List
    public class RMKeyList
extends java.util.AbstractList
    A list implementation that tries to get objects from aKey+"Size" or aKey+"Count" and aKey(index), eg., getThingCount(), getThing(index).

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  RMKeyList.InvalidKeyListException
      An exception class which is thrown when creating a new key-list with invalid object key.

    • Field Summary

      • Fields inherited from class java.util.AbstractList

        modCount

    • Constructor Summary

      Constructors 
      Constructor Description
      RMKeyList​(java.lang.Object anObj, java.lang.String aKey)
      Creates a new key list.
      RMKeyList​(java.lang.Object anObj, java.lang.String aKey, java.lang.String aSubkey)
      Creates a new key list.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void add​(int anIndex, java.lang.Object anObj)
      Adds the object at the given index.
      java.lang.Object create()
      Creates a new object for this list.
      java.lang.Object get​(int anIndex)
      Returns the list element at the given index.
      java.lang.Object remove​(int anIndex)
      Removes the object at the given index.
      java.lang.Object set​(int anIndex, java.lang.Object anObj)
      Resets the object at the given index to given object.
      int size()
      Returns the number of objects for key-list key.

      • Methods inherited from class java.util.AbstractList

        add, addAll, clear, equals, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, removeRange, subList

      • Methods inherited from class java.util.AbstractCollection

        addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface java.util.Collection

        parallelStream, removeIf, stream, toArray

      • Methods inherited from interface java.lang.Iterable

        forEach

      • Methods inherited from interface java.util.List

        addAll, contains, containsAll, isEmpty, remove, removeAll, replaceAll, retainAll, sort, spliterator, toArray, toArray

    • Constructor Detail

      • RMKeyList

        public RMKeyList​(java.lang.Object anObj,
                 java.lang.String aKey)
        Creates a new key list.

      • RMKeyList

        public RMKeyList​(java.lang.Object anObj,
                 java.lang.String aKey,
                 java.lang.String aSubkey)
        Creates a new key list.

    • Method Detail

      • size

        public int size()
        Returns the number of objects for key-list key.
        Specified by:
        size in interface java.util.Collection
        Specified by:
        size in interface java.util.List
        Specified by:
        size in class java.util.AbstractCollection

      • get

        public java.lang.Object get​(int anIndex)
        Returns the list element at the given index.
        Specified by:
        get in interface java.util.List
        Specified by:
        get in class java.util.AbstractList

      • set

        public java.lang.Object set​(int anIndex,
                            java.lang.Object anObj)
        Resets the object at the given index to given object.
        Specified by:
        set in interface java.util.List
        Overrides:
        set in class java.util.AbstractList

      • add

        public void add​(int anIndex,
                java.lang.Object anObj)
        Adds the object at the given index.
        Specified by:
        add in interface java.util.List
        Overrides:
        add in class java.util.AbstractList

      • remove

        public java.lang.Object remove​(int anIndex)
        Removes the object at the given index.
        Specified by:
        remove in interface java.util.List
        Overrides:
        remove in class java.util.AbstractList

      • create

        public java.lang.Object create()
        Creates a new object for this list.