Links (Spring HATEOAS 1.0.0.M1 API)

java.lang.Object
- org.springframework.hateoas.Links

All Implemented Interfaces:

Iterable<Link>
```
public class Links
extends Object
implements Iterable<Link>
```
Value object to represent a list of Links.

Author:

Oliver Gierke, Greg Turnquist

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Links.MergeMode
The mode how to merge two Links instances.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Links.MergeMode` The mode how to merge two `Links` instances.

Field Summary

Fields
Modifier and Type Field and Description

static Links NONE

Fields
Modifier and Type	Field and Description
`static Links`	`NONE`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Links`	`and(Iterable<Link> links)` Creates a new `Links` instance with all given `Link`s added.
`Links`	`and(Link... links)` Creates a new `Links` instance with all given `Link`s added.
`static Collector<Link,?,Links>`	`collector()` Creates a new `Collector` to collect a `Stream` of `Link`s into a `Links` instance.
`boolean`	`contains(Iterable<Link> links)` Returns whether the current `Links` contain all given `Link`s (but potentially others).
`boolean`	`contains(Link... links)` Returns whether the current `Links` contain all given `Link`s (but potentially others).
`boolean`	`containsSameLinksAs(Iterable<Link> links)` Returns whether the current `Links` instance contains exactly the same `Link` as the given one.
`boolean`	`equals(Object arg0)`
`Optional<Link>`	`getLink(LinkRelation rel)` Returns the `Link` with the given rel.
`Optional<Link>`	`getLink(String relation)` Returns a `Link` with the given relation if contained in the current `Links` instance, `Optional.empty()` otherwise.
`Link`	`getRequiredLink(LinkRelation relation)` Returns the `Link` with the given relation.
`Link`	`getRequiredLink(String rel)` Returns the `Link` with the given relation.
`int`	`hashCode()`
`boolean`	`hasLink(LinkRelation relation)` Returns whether the current `Links` contains a `Link` with the given relation.
`boolean`	`hasLink(String relation)` Returns whether the `Links` container contains a `Link` with the given relation.
`boolean`	`hasSingleLink()` Returns whether the `Links` contain a single `Link`.
`boolean`	`hasSize(long size)` Returns whether the current `Links` has the given size.
`boolean`	`isEmpty()` Returns whether the `Links` container is empty.
`Iterator<Link>`	`iterator()`
`Links`	`merge(Iterable<Link> links)` Merges the current `Links` with the given ones, skipping `Link`s already contained in the current instance.
`Links`	`merge(Link... links)` Merges the current `Links` with the given ones, skipping `Link`s already contained in the current instance.
`Links`	`merge(Links.MergeMode mode, Iterable<Link> links)` Merges the current `Links` with the given ones applying the given `Links.MergeMode`.
`Links`	`merge(Links.MergeMode mode, Link... links)` Merges the current `Links` with the given ones applying the given `Links.MergeMode`.
`static Links`	`of(Iterable<Link> links)` Creates a new `Links` instance from the given `Link`s.
`static Links`	`of(Link... links)` Creates a new `Links` instance from the given `Link`s.
`static Links`	`parse(String source)` Creates a `Links` instance from the given RFC5988-compatible link format.
`Stream<Link>`	`stream()` Creates a `Stream` of the current `Links`.
`List<Link>`	`toList()` Returns the current `Links` as `List`.
`String`	`toString()`
`static Links`	`valueOf(String source)` Deprecated. use `parse(String)` instead
`Links`	`without(LinkRelation relation)` Returns a `Links` with all `Link`s with the given `LinkRelation` removed.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
  - NONE
```
public static final Links NONE
```
- Method Detail
  - of
```
public static Links of(Link... links)
```
    Creates a new Links instance from the given Links.
    
    Parameters:
    
    links -
  - of
```
public static Links of(Iterable<Link> links)
```
    Creates a new Links instance from the given Links.
    
    Parameters:
    
    links -
  - valueOf
```
@Deprecated
public static Links valueOf(String source)
```
    Deprecated. use parse(String) instead
    
    Creates a Links instance from the given RFC5988-compatible link format.
    
    Parameters:
    
    source - a comma separated list of Link representations.
    
    Returns:
    
    the Links represented by the given String.
  - parse
```
public static Links parse(String source)
```
    Creates a Links instance from the given RFC5988-compatible link format.
    
    Parameters:
    
    source - a comma separated list of Link representations.
    
    Returns:
    
    the Links represented by the given String.
  - and
```
public Links and(Link... links)
```
    Creates a new Links instance with all given Links added. For conditional adding see merge(Link...).
    
    Parameters:
    
    links - must not be null.
    
    Returns:
    
    See Also:
    
    merge(Link...), merge(MergeMode, Link...)
  - and
```
public Links and(Iterable<Link> links)
```
    Creates a new Links instance with all given Links added. For conditional adding see merge(Iterable).
    
    Parameters:
    
    links - must not be null.
    
    Returns:
    
    See Also:
    
    merge(Iterable), merge(MergeMode, Iterable)
  - merge
```
public Links merge(Link... links)
```
    Merges the current Links with the given ones, skipping Links already contained in the current instance. For unconditional combination see and(Link...).
    
    Parameters:
    
    links - the Links to be merged, must not be null.
    
    Returns:
    
    See Also:
    
    Links.MergeMode.SKIP_BY_EQUALITY, and(Link...)
  - merge
```
public Links merge(Iterable<Link> links)
```
    Merges the current Links with the given ones, skipping Links already contained in the current instance. For unconditional combination see and(Link...).
    
    Parameters:
    
    links - the Links to be merged, must not be null.
    
    Returns:
    
    See Also:
    
    Links.MergeMode.SKIP_BY_EQUALITY, and(Link...)
  - merge
```
public Links merge(Links.MergeMode mode,
                   Link... links)
```
    Merges the current Links with the given ones applying the given Links.MergeMode.
    
    Parameters:
    
    mode - must not be null.
    
    links - must not be null.
    
    Returns:
  - merge
```
public Links merge(Links.MergeMode mode,
                   Iterable<Link> links)
```
    Merges the current Links with the given ones applying the given Links.MergeMode.
    
    Parameters:
    
    mode - must not be null.
    
    links - must not be null.
    
    Returns:
  - without
```
public Links without(LinkRelation relation)
```
    Returns a Links with all Links with the given LinkRelation removed.
    
    Parameters:
    
    relation - must not be null.
    
    Returns:
  - getLink
```
public Optional<Link> getLink(String relation)
```
    Returns a Link with the given relation if contained in the current Links instance, Optional.empty() otherwise.
    
    Parameters:
    
    relation - must not be null or empty.
    
    Returns:
  - getLink
```
public Optional<Link> getLink(LinkRelation rel)
```
    Returns the Link with the given rel.
    
    Parameters:
    
    rel - the relation type to lookup a link for.
    
    Returns:
    
    the link with the given rel or Optional#empty() if none found.
  - getRequiredLink
```
public Link getRequiredLink(String rel)
```
    Returns the Link with the given relation.
    
    Parameters:
    
    rel - the relation type to lookup a link for.
    
    Returns:
    
    Throws:
    
    IllegalArgumentException - if no link with the given relation was present.
    
    Since:
    
    1.0
  - getRequiredLink
```
public Link getRequiredLink(LinkRelation relation)
```
    Returns the Link with the given relation.
    
    Parameters:
    
    relation - the relation type to lookup a link for.
    
    Returns:
    
    Throws:
    
    IllegalArgumentException - if no link with the given relation was present.
  - hasLink
```
public boolean hasLink(String relation)
```
    Returns whether the Links container contains a Link with the given relation.
    
    Parameters:
    
    relation - must not be null or empty.
    
    Returns:
  - hasLink
```
public boolean hasLink(LinkRelation relation)
```
    Returns whether the current Links contains a Link with the given relation.
    
    Parameters:
    
    relation - must not be null.
    
    Returns:
  - isEmpty
```
public boolean isEmpty()
```
    Returns whether the Links container is empty.
    
    Returns:
  - hasSize
```
public boolean hasSize(long size)
```
    Returns whether the current Links has the given size.
    
    Parameters:
    
    size -
    
    Returns:
  - hasSingleLink
```
public boolean hasSingleLink()
```
    Returns whether the Links contain a single Link.
    
    Returns:
  - stream
```
public Stream<Link> stream()
```
    Creates a Stream of the current Links.
    
    Returns:
  - toList
```
public List<Link> toList()
```
    Returns the current Links as List.
    
    Returns:
  - contains
```
public boolean contains(Link... links)
```
    Returns whether the current Links contain all given Links (but potentially others).
    
    Parameters:
    
    links - must not be null.
    
    Returns:
  - contains
```
public boolean contains(Iterable<Link> links)
```
    Returns whether the current Links contain all given Links (but potentially others).
    
    Parameters:
    
    links - must not be null.
    
    Returns:
  - containsSameLinksAs
```
public boolean containsSameLinksAs(Iterable<Link> links)
```
    Returns whether the current Links instance contains exactly the same Link as the given one.
    
    Parameters:
    
    links - must not be null.
    
    Returns:
  - collector
```
public static Collector<Link,?,Links> collector()
```
    Creates a new Collector to collect a Stream of Links into a Links instance.
    
    Returns:
    
    will never be null.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - iterator
```
public Iterator<Link> iterator()
```
    Specified by:
    
    iterator in interface Iterable<Link>
  - equals
```
public boolean equals(Object arg0)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class Links

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Field Detail

NONE

Method Detail

of

of

valueOf

parse

and

and

merge

merge

merge

merge

without

getLink

getLink

getRequiredLink

getRequiredLink

hasLink

hasLink

isEmpty

hasSize

hasSingleLink

stream

toList

contains

contains

containsSameLinksAs

collector

toString

iterator

equals

hashCode