com.atlassian.jira.rest.client.api

Class OptionalIterable<T>

java.lang.Object

com.atlassian.jira.rest.client.api.OptionalIterable<T>

All Implemented Interfaces:

java.lang.Iterable<T>

public class OptionalIterable<T>
extends java.lang.Object
implements java.lang.Iterable<T>

Represent iterable which is optional (for example due to lack of field in old REST API version).
This iterable is intended to be not null, so you can always get items by using iterator. If you need to check if value was actually provided then use isSupported().

Since:

v1.0

Constructor Summary

Constructors

Constructor and Description
OptionalIterable(java.lang.Iterable<T> iterable)

Method Summary

Methods

Modifier and Type	Method and Description
static <T> OptionalIterable<T>	absent()
boolean	isSupported()
java.util.Iterator<T>	iterator()

Methods inherited from class java.lang.Object

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

Constructor Detail

OptionalIterable

public OptionalIterable(@Nullable
                java.lang.Iterable<T> iterable)

Method Detail

absent

public static <T> OptionalIterable<T> absent()

iterator

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

Specified by:

iterator in interface java.lang.Iterable<T>

Returns:

iterator for original iterable if isSupported() is true, or empty iterator in other case.

isSupported

public boolean isSupported()

Returns:

true if server supports this field