CharSets (Primitive-Collections 0.7.0 API)

java.lang.Object
- speiger.src.collections.chars.utils.CharSets

public class CharSets
extends java.lang.Object

A Helper class for sets

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CharSets.UnmodifiableSet
Unmodifyable Set wrapper that helps is used with unmodifyableSet function

Nested Classes
Modifier and Type	Class and Description
`static class`	`CharSets.UnmodifiableSet` Unmodifyable Set wrapper that helps is used with unmodifyableSet function

Constructor Summary

Constructors
Constructor and Description

CharSets()

Constructors
Constructor and Description
`CharSets()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static CharSet`	`empty()` EmptySet getter
`static CharSet`	`singleton(char element)` Creates a Singleton set of a given element
`static CharNavigableSet`	`synchronize(CharNavigableSet s)` Creates a Synchronized NavigableSet while preserving the ITrimmable interface
`static CharNavigableSet`	`synchronize(CharNavigableSet s, java.lang.Object mutex)` Creates a Synchronized NavigableSet while preserving the ITrimmable interface
`static CharOrderedSet`	`synchronize(CharOrderedSet s)` Creates a Synchronized OrderedSet while preserving the ITrimmable interface
`static CharOrderedSet`	`synchronize(CharOrderedSet s, java.lang.Object mutex)` Creates a Synchronized OrderedSet while preserving the ITrimmable interface
`static CharSet`	`synchronize(CharSet s)` Creates a Synchronized set while preserving the ITrimmable interface
`static CharSet`	`synchronize(CharSet s, java.lang.Object mutex)` Creates a Synchronized set while preserving the ITrimmable interface
`static CharSortedSet`	`synchronize(CharSortedSet s)` Creates a Synchronized SortedSet while preserving the ITrimmable interface
`static CharSortedSet`	`synchronize(CharSortedSet s, java.lang.Object mutex)` Creates a Synchronized SortedSet while preserving the ITrimmable interface
`static CharNavigableSet`	`unmodifiable(CharNavigableSet s)` Creates Unmodifyable NavigableSet wrapper
`static CharOrderedSet`	`unmodifiable(CharOrderedSet s)` Creates Unmodifyable OrderedSet wrapper
`static CharSet`	`unmodifiable(CharSet s)` Creates Unmodifyable Set wrapper
`static CharSortedSet`	`unmodifiable(CharSortedSet s)` Creates Unmodifyable SortedSet wrapper

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CharSets
```
public CharSets()
```
- Method Detail
  - empty
```
public static CharSet empty()
```
    EmptySet getter
    
    Returns:
    
    a EmptySet
  - synchronize
```
public static CharSet synchronize(CharSet s)
```
    Creates a Synchronized set while preserving the ITrimmable interface
    
    Parameters:
    
    s - the set that should be synchronized
    
    Returns:
    
    a set that is synchronized
    
    Note:
    
    if the set is already synchronized then it will just self return it
  - synchronize
```
public static CharSet synchronize(CharSet s,
                                  java.lang.Object mutex)
```
    Creates a Synchronized set while preserving the ITrimmable interface
    
    Parameters:
    
    s - the set that should be synchronized
    
    mutex - controller for access
    
    Returns:
    
    a set that is synchronized
    
    Note:
    
    if the set is already synchronized then it will just self return it
  - synchronize
```
public static CharSortedSet synchronize(CharSortedSet s)
```
    Creates a Synchronized SortedSet while preserving the ITrimmable interface
    
    Parameters:
    
    s - the set that should be synchronized
    
    Returns:
    
    a SortedSet that is synchronized
    
    Note:
    
    if the set is already synchronized then it will just self return it
  - synchronize
```
public static CharSortedSet synchronize(CharSortedSet s,
                                        java.lang.Object mutex)
```
    Creates a Synchronized SortedSet while preserving the ITrimmable interface
    
    Parameters:
    
    s - the set that should be synchronized
    
    mutex - controller for access
    
    Returns:
    
    a SortedSet that is synchronized
    
    Note:
    
    if the set is already synchronized then it will just self return it
  - synchronize
```
public static CharOrderedSet synchronize(CharOrderedSet s)
```
    Creates a Synchronized OrderedSet while preserving the ITrimmable interface
    
    Parameters:
    
    s - the set that should be synchronized
    
    Returns:
    
    a OrderedSet that is synchronized
    
    Note:
    
    if the set is already synchronized then it will just self return it
  - synchronize
```
public static CharOrderedSet synchronize(CharOrderedSet s,
                                         java.lang.Object mutex)
```
    Creates a Synchronized OrderedSet while preserving the ITrimmable interface
    
    Parameters:
    
    s - the set that should be synchronized
    
    mutex - controller for access
    
    Returns:
    
    a OrderedSet that is synchronized
    
    Note:
    
    if the set is already synchronized then it will just self return it
  - synchronize
```
public static CharNavigableSet synchronize(CharNavigableSet s)
```
    Creates a Synchronized NavigableSet while preserving the ITrimmable interface
    
    Parameters:
    
    s - the set that should be synchronized
    
    Returns:
    
    a NavigableSet that is synchronized
    
    Note:
    
    if the set is already synchronized then it will just self return it
  - synchronize
```
public static CharNavigableSet synchronize(CharNavigableSet s,
                                           java.lang.Object mutex)
```
    Creates a Synchronized NavigableSet while preserving the ITrimmable interface
    
    Parameters:
    
    s - the set that should be synchronized
    
    mutex - controller for access
    
    Returns:
    
    a NavigableSet that is synchronized
    
    Note:
    
    if the set is already synchronized then it will just self return it
  - unmodifiable
```
public static CharSet unmodifiable(CharSet s)
```
    Creates Unmodifyable Set wrapper
    
    Parameters:
    
    s - set that should be made unmodifiable
    
    Returns:
    
    a UnmodifyableSet, if the set is already unmodifiable then it returns itself
  - unmodifiable
```
public static CharSortedSet unmodifiable(CharSortedSet s)
```
    Creates Unmodifyable SortedSet wrapper
    
    Parameters:
    
    s - sortedSet that should be made unmodifiable
    
    Returns:
    
    a UnmodifyableSortedSet, if the set is already unmodifiable then it returns itself
  - unmodifiable
```
public static CharOrderedSet unmodifiable(CharOrderedSet s)
```
    Creates Unmodifyable OrderedSet wrapper
    
    Parameters:
    
    s - OrderedSet that should be made unmodifiable
    
    Returns:
    
    a UnmodifyableOrderedSet, if the set is already unmodifiable then it returns itself
  - unmodifiable
```
public static CharNavigableSet unmodifiable(CharNavigableSet s)
```
    Creates Unmodifyable NavigableSet wrapper
    
    Parameters:
    
    s - navigableSet that should be made unmodifiable
    
    Returns:
    
    a UnmodifyableNavigableSet, if the set is already unmodifiable then it returns itself
  - singleton
```
public static CharSet singleton(char element)
```
    Creates a Singleton set of a given element
    
    Parameters:
    
    element - the element that should be converted into a singleton set
    
    Returns:
    
    a singletonset of the given element

Class CharSets

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CharSets

Method Detail

empty

synchronize

synchronize

synchronize

synchronize

synchronize

synchronize

synchronize

synchronize

unmodifiable

unmodifiable

unmodifiable

unmodifiable

singleton