Class CharSets


  • public final class CharSets
    extends Object
    A class providing static methods and objects that do useful things with type-specific sets.
    See Also:
    Collections
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  CharSets.EmptySet
      An immutable class representing the empty set and implementing a type-specific set interface.
      static class  CharSets.Singleton
      An immutable class representing a type-specific singleton set.
      static class  CharSets.SynchronizedSet
      A synchronized wrapper class for sets.
      static class  CharSets.UnmodifiableSet
      An unmodifiable wrapper class for sets.
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static CharSet from​(char from)
      Returns an unmodifiable type-specific set containing elements greater than or equal to a given element.
      static CharSet fromTo​(char from, char to)
      Returns an unmodifiable type-specific set containing elements in the given range.
      static CharSet singleton​(char element)
      Returns a type-specific immutable set containing only the specified element.
      static CharSet singleton​(Character element)
      Returns a type-specific immutable set containing only the specified element.
      static CharSet synchronize​(CharSet s)
      Returns a synchronized type-specific set backed by the given type-specific set.
      static CharSet synchronize​(CharSet s, Object sync)
      Returns a synchronized type-specific set backed by the given type-specific set, using an assigned object to synchronize.
      static CharSet to​(char to)
      Returns an unmodifiable type-specific set containing elements smaller than a given element.
      static CharSet unmodifiable​(CharSet s)
      Returns an unmodifiable type-specific set backed by the given type-specific set.
    • Field Detail

      • EMPTY_SET

        public static final CharSets.EmptySet EMPTY_SET
        An empty set (immutable). It is serializable and cloneable.
    • Method Detail

      • singleton

        public static CharSet singleton​(char element)
        Returns a type-specific immutable set containing only the specified element. The returned set is serializable and cloneable.
        Parameters:
        element - the only element of the returned set.
        Returns:
        a type-specific immutable set containing just element.
      • singleton

        public static CharSet singleton​(Character element)
        Returns a type-specific immutable set containing only the specified element. The returned set is serializable and cloneable.
        Parameters:
        element - the only element of the returned set.
        Returns:
        a type-specific immutable set containing just element.
      • synchronize

        public static CharSet synchronize​(CharSet s)
        Returns a synchronized type-specific set backed by the given type-specific set.
        Parameters:
        s - the set to be wrapped in a synchronized set.
        Returns:
        a synchronized view of the specified set.
        See Also:
        Collections.synchronizedSet(Set)
      • synchronize

        public static CharSet synchronize​(CharSet s,
                                          Object sync)
        Returns a synchronized type-specific set backed by the given type-specific set, using an assigned object to synchronize.
        Parameters:
        s - the set to be wrapped in a synchronized set.
        sync - an object that will be used to synchronize the access to the set.
        Returns:
        a synchronized view of the specified set.
        See Also:
        Collections.synchronizedSet(Set)
      • unmodifiable

        public static CharSet unmodifiable​(CharSet s)
        Returns an unmodifiable type-specific set backed by the given type-specific set.
        Parameters:
        s - the set to be wrapped in an unmodifiable set.
        Returns:
        an unmodifiable view of the specified set.
        See Also:
        Collections.unmodifiableSet(Set)
      • fromTo

        public static CharSet fromTo​(char from,
                                     char to)
        Returns an unmodifiable type-specific set containing elements in the given range.
        Parameters:
        from - the starting element (lower bound) of the set (inclusive).
        to - the ending element (upper bound) of the set (exclusive).
        Returns:
        an unmodifiable set containing the elements in the given range.
      • from

        public static CharSet from​(char from)
        Returns an unmodifiable type-specific set containing elements greater than or equal to a given element.
        Parameters:
        from - the starting element (lower bound) of the set (inclusive).
        Returns:
        an unmodifiable set containing the elements greater than or equal to from.
      • to

        public static CharSet to​(char to)
        Returns an unmodifiable type-specific set containing elements smaller than a given element.
        Parameters:
        to - the ending element (upper bound) of the set (exclusive).
        Returns:
        an unmodifiable set containing the elements smaller than to.