Class HalLinkRelation
java.lang.Object
org.springframework.hateoas.mediatype.hal.HalLinkRelation
- All Implemented Interfaces:
MessageSourceResolvable
,LinkRelation
Value object for HAL based
LinkRelation
, i.e. a relation that can be curied.- Author:
- Oliver Drotbohm
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
Simple builder interface to easily create multipleHalLinkRelation
s for a single curie. -
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptionCreates a newHalLinkRelation
curied to the given value.curieBuilder
(String curie) Creates a newHalLinkRelation.HalLinkRelationBuilder
for the given curie.static HalLinkRelation
Creates a newHalLinkRelation
for a curied relation.curieIfUncuried
(String curie) Returns a curiedHalLinkRelation
either using the existing curie or the given one if previously uncuried.boolean
String[]
getCodes()
int
hashCode()
boolean
isCuried()
Returns whether the link relation is curied.Returns a newLinkRelation
with its relation mapped by the given function, unless it is an IANA one.static HalLinkRelation
of
(LinkRelation relation) Returns aHalLinkRelation
for the given generalLinkRelation
.toString()
static HalLinkRelation
Creates a new uncuriedHalLinkRelation
.value()
Return the link relation's value.Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.springframework.hateoas.LinkRelation
isSameAs
Methods inherited from interface org.springframework.context.MessageSourceResolvable
getArguments
-
Field Details
-
CURIES
-
-
Method Details
-
of
Returns aHalLinkRelation
for the given generalLinkRelation
.- Parameters:
relation
- must not be null.- Returns:
-
curied
Creates a newHalLinkRelation
for a curied relation.- Parameters:
curie
- the curie, must not be null or empty.rel
- the link relation to be used, must not be null.- Returns:
-
uncuried
Creates a new uncuriedHalLinkRelation
.- Parameters:
rel
- the link relation to be used, must not be null.- Returns:
-
curieBuilder
Creates a newHalLinkRelation.HalLinkRelationBuilder
for the given curie.- Parameters:
curie
- must not be null or empty.- Returns:
- will never be null.
-
curie
Creates a newHalLinkRelation
curied to the given value.- Parameters:
curie
- must not be null or empty.- Returns:
-
curieIfUncuried
Returns a curiedHalLinkRelation
either using the existing curie or the given one if previously uncuried.- Parameters:
curie
- must not be null or empty.- Returns:
-
isCuried
public boolean isCuried()Returns whether the link relation is curied.- Returns:
-
map
Description copied from interface:LinkRelation
Returns a newLinkRelation
with its relation mapped by the given function, unless it is an IANA one. Implementors are encouraged to override this method to redeclare the return type to be itself.- Specified by:
map
in interfaceLinkRelation
- Parameters:
mapper
- must not be null.- Returns:
- See Also:
-
value
Description copied from interface:LinkRelation
Return the link relation's value.- Specified by:
value
in interfaceLinkRelation
-
getCodes
- Specified by:
getCodes
in interfaceMessageSourceResolvable
-
getDefaultMessage
- Specified by:
getDefaultMessage
in interfaceMessageSourceResolvable
-
getLocalPart
-
equals
-
hashCode
public int hashCode() -
toString
-