Package org.sosy_lab.common

Class Optionals

java.lang.Object

org.sosy_lab.common.Optionals

public final class Optionals
extends Object

Utilities for Optional.

Method Summary

Modifier and Type	Method	Description
static <T> ImmutableSet<T>	asSet(Optional<T> optional)	Return a set that is either empty or contains the present instance of the Optional.
static <T> Stream<T>	asStream(Optional<T> optional)	Deprecated. use Optional.stream()
static Ordering<OptionalDouble>	comparingDoubleEmptyFirst()	Return a Ordering for OptionalDouble that compares empty optionals as smaller than all non-empty instances, and compares present doubles using their natural order.
static Ordering<OptionalDouble>	comparingDoubleEmptyLast()	Return a Ordering for OptionalDouble that compares empty optionals as larger than all non-empty instances, and compares present doubles using their natural order.
static <T extends Comparable<T>> Comparator<Optional<T>>	comparingEmptyFirst()	Deprecated. Use Comparators.emptiesFirst(Comparator)
static <T> Comparator<Optional<T>>	comparingEmptyFirst(Comparator<T> comparator)	Deprecated. Use Comparators.emptiesFirst(Comparator)
static <T extends Comparable<T>> Comparator<Optional<T>>	comparingEmptyLast()	Deprecated. Use Comparators.emptiesLast(Comparator)
static <T> Comparator<Optional<T>>	comparingEmptyLast(Comparator<T> comparator)	Deprecated. Use Comparators.emptiesLast(Comparator)
static Ordering<OptionalInt>	comparingIntEmptyFirst()	Return a Ordering for OptionalInt that compares empty optionals as smaller than all non-empty instances, and compares present integers using their natural order.
static Ordering<OptionalInt>	comparingIntEmptyLast()	Return a Ordering for OptionalInt that compares empty optionals as larger than all non-empty instances, and compares present integers using their natural order.
static Ordering<OptionalLong>	comparingLongEmptyFirst()	Return a Ordering for OptionalLong that compares empty optionals as smaller than all non-empty instances, and compares present longs using their natural order.
static Ordering<OptionalLong>	comparingLongEmptyLast()	Return a Ordering for OptionalLong that compares empty optionals as larger than all non-empty instances, and compares present longs using their natural order.
static <T> Optional<T>	fromGuavaOptional(Optional<T> optional)	Deprecated. use Optional.toJavaUtil()
static DoubleStream	presentDoubles(Stream<OptionalDouble> stream)	Get a DoubleStream of the present doubles of a stream of OptionalDoubles.
static <T> FluentIterable<T>	presentInstances(Iterable<Optional<T>> iterable)	Get an Iterable of the present instances of an iterable of Optionals.
static <T> Stream<T>	presentInstances(Stream<Optional<T>> stream)	Get a Stream of the present instances of a stream of Optionals.
static IntStream	presentInts(Stream<OptionalInt> stream)	Get a IntStream of the present integers of a stream of OptionalInts.
static LongStream	presentLongs(Stream<OptionalLong> stream)	Get a LongStream of the present longs of a stream of OptionalLongs.
static <T> Optional<T>	toGuavaOptional(Optional<T> optional)	Deprecated. use Optional.fromJavaUtil(Optional)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

toGuavaOptional

@Deprecated
@InlineMe(replacement="com.google.common.base.Optional.fromJavaUtil(checkNotNull(optional))",
          staticImports="com.google.common.base.Preconditions.checkNotNull")
public static <T> Optional<T> toGuavaOptional(Optional<T> optional)

Deprecated.

use Optional.fromJavaUtil(Optional)

Convert an Optional to a Guava Optional.

fromGuavaOptional

@Deprecated
@InlineMe(replacement="optional.toJavaUtil()")
public static <T> Optional<T> fromGuavaOptional(Optional<T> optional)

Deprecated.

use Optional.toJavaUtil()

Convert a Guava Optional to an Optional.

asSet

public static <T> ImmutableSet<T> asSet(Optional<T> optional)

Return a set that is either empty or contains the present instance of the Optional.

Can be used with FluentIterable.transformAndConcat(com.google.common.base.Function) to project an Iterable to the present instances. However, using presentInstances(Iterable) would be more efficient.

Parameters:

optional - An Optional.

Returns:

A set with size at most one.

asStream

@Deprecated
@InlineMe(replacement="optional.stream()")
public static <T> Stream<T> asStream(Optional<T> optional)

Deprecated.

use Optional.stream()

Return a stream that is either empty or contains the present instance of the optional.

Can be used with Stream.flatMap(java.util.function.Function) to project a stream to the present instances. However, using presentInstances(Stream) would be more efficient.

Parameters:

optional - An Optional.

Returns:

A stream with size at most one.

presentInstances

public static <T> FluentIterable<T> presentInstances(Iterable<Optional<T>> iterable)

Get an Iterable of the present instances of an iterable of Optionals.

presentInstances

public static <T> Stream<T> presentInstances(Stream<Optional<T>> stream)

Get a Stream of the present instances of a stream of Optionals.

presentInts

public static IntStream presentInts(Stream<OptionalInt> stream)

Get a IntStream of the present integers of a stream of OptionalInts.

presentLongs

public static LongStream presentLongs(Stream<OptionalLong> stream)

Get a LongStream of the present longs of a stream of OptionalLongs.

presentDoubles

public static DoubleStream presentDoubles(Stream<OptionalDouble> stream)

Get a DoubleStream of the present doubles of a stream of OptionalDoubles.

comparingEmptyFirst

@Deprecated
@InlineMe(replacement="Comparators.emptiesFirst(Comparator.<T>naturalOrder())",
          imports={"com.google.common.collect.Comparators","java.util.Comparator"})
public static <T extends Comparable<T>>
Comparator<Optional<T>> comparingEmptyFirst()

Deprecated.

Use Comparators.emptiesFirst(Comparator)

Return a Ordering for Optional that compares empty optionals as smaller than all non-empty instances, and compares present values using their natural order.

comparingEmptyFirst

@Deprecated
@InlineMe(replacement="Comparators.emptiesFirst(comparator)",
          imports="com.google.common.collect.Comparators")
public static <T> Comparator<Optional<T>> comparingEmptyFirst(Comparator<T> comparator)

Deprecated.

Use Comparators.emptiesFirst(Comparator)

Return a Ordering for Optional that compares empty optionals as smaller than all non-empty instances, and compares present values using the given comparator.

comparingEmptyLast

@Deprecated
@InlineMe(replacement="Comparators.emptiesLast(Comparator.<T>naturalOrder())",
          imports={"com.google.common.collect.Comparators","java.util.Comparator"})
public static <T extends Comparable<T>>
Comparator<Optional<T>> comparingEmptyLast()

Deprecated.

Use Comparators.emptiesLast(Comparator)

Return a Ordering for Optional that compares empty optionals as larger than all non-empty instances, and compares present values using their natural order.

comparingEmptyLast

@Deprecated
@InlineMe(replacement="Comparators.emptiesLast(comparator)",
          imports="com.google.common.collect.Comparators")
public static <T> Comparator<Optional<T>> comparingEmptyLast(Comparator<T> comparator)

Deprecated.

Use Comparators.emptiesLast(Comparator)

Return a Ordering for Optional that compares empty optionals as larger than all non-empty instances, and compares present values using the given comparator.

comparingIntEmptyFirst

public static Ordering<OptionalInt> comparingIntEmptyFirst()

Return a Ordering for OptionalInt that compares empty optionals as smaller than all non-empty instances, and compares present integers using their natural order.

comparingIntEmptyLast

public static Ordering<OptionalInt> comparingIntEmptyLast()

Return a Ordering for OptionalInt that compares empty optionals as larger than all non-empty instances, and compares present integers using their natural order.

comparingLongEmptyFirst

public static Ordering<OptionalLong> comparingLongEmptyFirst()

Return a Ordering for OptionalLong that compares empty optionals as smaller than all non-empty instances, and compares present longs using their natural order.

comparingLongEmptyLast

public static Ordering<OptionalLong> comparingLongEmptyLast()

Return a Ordering for OptionalLong that compares empty optionals as larger than all non-empty instances, and compares present longs using their natural order.

comparingDoubleEmptyFirst

public static Ordering<OptionalDouble> comparingDoubleEmptyFirst()

Return a Ordering for OptionalDouble that compares empty optionals as smaller than all non-empty instances, and compares present doubles using their natural order.

comparingDoubleEmptyLast

public static Ordering<OptionalDouble> comparingDoubleEmptyLast()

Return a Ordering for OptionalDouble that compares empty optionals as larger than all non-empty instances, and compares present doubles using their natural order.