Package cern.nxcals.api.backport.domain.core.metadata

Class VariableListSet

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.String,​VariableList>, java.util.NavigableMap<java.lang.String,​VariableList>, java.util.SortedMap<java.lang.String,​VariableList>
    public class VariableListSet
extends java.util.TreeMap<java.lang.String,​VariableList>
    See Also:
    Serialized Form

    • Nested Class Summary

      • Nested classes/interfaces inherited from class java.util.AbstractMap

        java.util.AbstractMap.SimpleEntry<K extends java.lang.Object,​V extends java.lang.Object>, java.util.AbstractMap.SimpleImmutableEntry<K extends java.lang.Object,​V extends java.lang.Object>

    • Constructor Summary

      Constructors 
      Constructor Description
      VariableListSet()  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addVariableList​(VariableList variableList)  
      static java.util.stream.Collector<VariableList,​VariableListSet,​VariableListSet> collector()  
      boolean containsVariableList​(java.lang.String listName)
      Indicates whether of not this object contains a VariableList with the given name.
      VariableList getVariableList​(int idx)
      Gets a VariableList from the given index in the VariableListSet if it exists.
      VariableList getVariableList​(java.lang.String listName)
      Gets a VariableList with the given name from the VariableListSet if it exists.
      int getVariableListCount()
      Gets a count of the number of VariableList objects within the VariableListSet.
      long[] getVariableListIds()
      Gets a long [] of all variable Ids in this VariableListSet.
      java.util.Set<java.lang.String> getVariableListNames()
      Get a set of the names of the VariableList objects within the VariableListSet.
      java.util.Collection<VariableList> getVariableLists()
      Gets a Collection of all the VariableList objects within the VariableListSet.
      java.util.Iterator<VariableList> iterator()  
      void removeAllVariableLists()
      Removes all VariableList objects from the VariableListSet.
      boolean removeVariableList​(java.lang.String listName)
      Removes the VariableList with the given name from the VariableListSet.

      • Methods inherited from class java.util.TreeMap

        ceilingEntry, ceilingKey, clear, clone, comparator, containsKey, containsValue, descendingKeySet, descendingMap, entrySet, firstEntry, firstKey, floorEntry, floorKey, forEach, get, headMap, headMap, higherEntry, higherKey, keySet, lastEntry, lastKey, lowerEntry, lowerKey, navigableKeySet, pollFirstEntry, pollLastEntry, put, putAll, remove, replace, replace, replaceAll, size, subMap, subMap, tailMap, tailMap, values

      • Methods inherited from class java.util.AbstractMap

        equals, hashCode, isEmpty, toString

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from interface java.util.Map

        compute, computeIfAbsent, computeIfPresent, equals, getOrDefault, hashCode, isEmpty, merge, putIfAbsent, remove

    • Constructor Detail

      • VariableListSet

        public VariableListSet()

    • Method Detail

      • getVariableList

        public VariableList getVariableList​(java.lang.String listName)
        Gets a VariableList with the given name from the VariableListSet if it exists.
        Parameters:
        listName - - the name of the required VariableList.
        Returns:
        the VariableList with given name if it exists within the VariableListSet. Returns null if does not exist.

      • getVariableList

        public VariableList getVariableList​(int idx)
        Gets a VariableList from the given index in the VariableListSet if it exists.
        Parameters:
        idx - - the index of the required VariableList in the VariableListSet.
        Returns:
        the VariableList with given index if it exists within the VariableListSet. Returns null if does not exist.

      • getVariableListCount

        public int getVariableListCount()
        Gets a count of the number of VariableList objects within the VariableListSet.
        Returns:
        a count of the number of VariableList objects within the VariableListSet.

      • getVariableListNames

        public java.util.Set<java.lang.String> getVariableListNames()
        Get a set of the names of the VariableList objects within the VariableListSet.
        Returns:
        a set of the names of the VariableList objects within the VariableListSet.

      • getVariableLists

        public java.util.Collection<VariableList> getVariableLists()
        Gets a Collection of all the VariableList objects within the VariableListSet.
        Returns:
        - a Collection of all the VariableList objects within the VariableListSet.

      • getVariableListIds

        public long[] getVariableListIds()
        Gets a long [] of all variable Ids in this VariableListSet.
        Returns:
        a long [] of all variable Ids in this VariableListSet.

      • addVariableList

        public void addVariableList​(VariableList variableList)

      • containsVariableList

        public boolean containsVariableList​(java.lang.String listName)
        Indicates whether of not this object contains a VariableList with the given name.
        Parameters:
        listName - - the name of the VariableList object to search for.
        Returns:
        - true if this object is representing a VariableList with the given name.

      • iterator

        public java.util.Iterator<VariableList> iterator()

      • removeVariableList

        public boolean removeVariableList​(java.lang.String listName)
        Removes the VariableList with the given name from the VariableListSet.
        Parameters:
        listName - - the name of the VariableList to be removed from the VariableListSet.
        Returns:
        - true if the VariableList with the given name was removed from the VariableListSet.

      • removeAllVariableLists

        public void removeAllVariableLists()
        Removes all VariableList objects from the VariableListSet.