A B C E G H I L R S U 
All Classes All Packages

A

adaptTo(Class<T>) - Method in class io.wcm.caravan.hal.resource.HalResource
 
addEmbedded(String, HalResource...) - Method in class io.wcm.caravan.hal.resource.HalResource
Embed resources for the given relation
addEmbedded(String, Iterable<HalResource>) - Method in class io.wcm.caravan.hal.resource.HalResource
Embed resources for the given relation
addLinks(String, Link...) - Method in class io.wcm.caravan.hal.resource.HalResource
Adds links for the given relation
addLinks(String, Iterable<Link>) - Method in class io.wcm.caravan.hal.resource.HalResource
Adds links for the given relation
addState(ObjectNode) - Method in class io.wcm.caravan.hal.resource.HalResource
Adds state to the resource.
augment(HalResource) - Method in class io.wcm.caravan.hal.resource.util.HalCuriAugmenter
Deprecated.
Augments a HAL resource by CURI links.

B

build() - Method in class io.wcm.caravan.hal.resource.util.HalBuilder
Deprecated.
 

C

collectEmbedded(String) - Method in class io.wcm.caravan.hal.resource.HalResource
recursively collects embedded resources of a specific rel
collectLinks(String) - Method in class io.wcm.caravan.hal.resource.HalResource
recursively collects links within this resource and all embedded resources
CONTENT_TYPE - Static variable in class io.wcm.caravan.hal.resource.HalResource
The mime content type
convert(Object) - Static method in class io.wcm.caravan.hal.resource.HalResourceFactory
Deprecated.
use a Jackson ObjectMapper instead
createLink(String) - Static method in class io.wcm.caravan.hal.resource.HalResourceFactory
Deprecated.
use the constructor instead
createResource(ObjectNode, String) - Static method in class io.wcm.caravan.hal.resource.HalResourceFactory
Deprecated.
just create HalResource and Link instances using the new constructors
createResource(Object, String) - Static method in class io.wcm.caravan.hal.resource.HalResourceFactory
Deprecated.
just create HalResource and Link instances using the new constructors
createResource(String) - Static method in class io.wcm.caravan.hal.resource.HalResourceFactory
Deprecated.
just create HalResource and Link instances using the new constructors
curi(String, String) - Method in class io.wcm.caravan.hal.resource.util.HalBuilder
Deprecated.
 

E

equals(Object) - Method in class io.wcm.caravan.hal.resource.Link
 

G

get(String) - Method in class io.wcm.caravan.hal.resource.util.HalCuriAugmenter
Deprecated.
Returns the CURI link for a given CURI name.
getAllLinks(HalResource) - Static method in class io.wcm.caravan.hal.resource.util.HalUtil
Returns all links in a HAL resource and its embedded resourcess except CURI links.
getAllLinks(HalResource, Predicate<Pair<String, Link>>) - Static method in class io.wcm.caravan.hal.resource.util.HalUtil
Returns all links in a HAL resource and its embedded resources except CURI links fitting the given predicate.
getAllLinksForRelation(HalResource, String) - Static method in class io.wcm.caravan.hal.resource.util.HalUtil
Returns all links in a HAL resource and its embedded resources fitting the supplied relation.
getDeprecation() - Method in class io.wcm.caravan.hal.resource.Link
 
getEmbedded() - Method in class io.wcm.caravan.hal.resource.HalResource
 
getEmbedded(String) - Method in class io.wcm.caravan.hal.resource.HalResource
 
getEmbeddedResource(String) - Method in class io.wcm.caravan.hal.resource.HalResource
 
getHref() - Method in class io.wcm.caravan.hal.resource.Link
 
getHreflang() - Method in class io.wcm.caravan.hal.resource.Link
 
getLink() - Method in class io.wcm.caravan.hal.resource.HalResource
 
getLink(String) - Method in class io.wcm.caravan.hal.resource.HalResource
 
getLinks() - Method in class io.wcm.caravan.hal.resource.HalResource
 
getLinks(String) - Method in class io.wcm.caravan.hal.resource.HalResource
 
getModel() - Method in interface io.wcm.caravan.hal.resource.HalObject
Returns the JSON model.
getModel() - Method in class io.wcm.caravan.hal.resource.HalResource
 
getModel() - Method in class io.wcm.caravan.hal.resource.Link
 
getName() - Method in class io.wcm.caravan.hal.resource.Link
 
getProfile() - Method in class io.wcm.caravan.hal.resource.Link
 
getStateAsObject(HalResource, Class<T>) - Static method in class io.wcm.caravan.hal.resource.HalResourceFactory
Deprecated.
use HalResource.adaptTo(Class)
getStateFieldNames() - Method in class io.wcm.caravan.hal.resource.HalResource
 
getTitle() - Method in class io.wcm.caravan.hal.resource.Link
 
getType() - Method in class io.wcm.caravan.hal.resource.Link
 

H

HalBuilder - Class in io.wcm.caravan.hal.resource.util
Deprecated.
Will get removed
HalBuilder(ObjectNode, String) - Constructor for class io.wcm.caravan.hal.resource.util.HalBuilder
Deprecated.
 
HalBuilder(Object, String) - Constructor for class io.wcm.caravan.hal.resource.util.HalBuilder
Deprecated.
 
HalBuilder(String) - Constructor for class io.wcm.caravan.hal.resource.util.HalBuilder
Deprecated.
 
HalBuilder(String, String) - Constructor for class io.wcm.caravan.hal.resource.util.HalBuilder
Deprecated.
 
HalBuilder(String, String, String) - Constructor for class io.wcm.caravan.hal.resource.util.HalBuilder
Deprecated.
 
HalCuriAugmenter - Class in io.wcm.caravan.hal.resource.util
Deprecated.
This is replaced by HalDocsAugmenter from the io.wcm.caravan.hal.docs bundle.
HalCuriAugmenter() - Constructor for class io.wcm.caravan.hal.resource.util.HalCuriAugmenter
Deprecated.
 
HalObject - Interface in io.wcm.caravan.hal.resource
Simple interface to get access to the model of an HAL object.
HalResource - Class in io.wcm.caravan.hal.resource
Bean representation of a HAL resource.
HalResource() - Constructor for class io.wcm.caravan.hal.resource.HalResource
Create an empty HAL resource, with no object state or links
HalResource(JsonNode) - Constructor for class io.wcm.caravan.hal.resource.HalResource
Create a new HalResource with the state from the given JSON object
HalResource(JsonNode, String) - Constructor for class io.wcm.caravan.hal.resource.HalResource
Create a new HalResource with the state from the given JSON object
HalResource(ObjectNode) - Constructor for class io.wcm.caravan.hal.resource.HalResource
Create a new HalResource with the state from the given JSON object
HalResource(Object) - Constructor for class io.wcm.caravan.hal.resource.HalResource
Create a new HalResource with the state from the given POJO
HalResource(Object, String) - Constructor for class io.wcm.caravan.hal.resource.HalResource
Create a new HalResource with the state from the given POJO
HalResource(String) - Constructor for class io.wcm.caravan.hal.resource.HalResource
Create a HAL resource with empty state that only contains a self link with the given URI
HalResourceFactory - Class in io.wcm.caravan.hal.resource
Deprecated.
just create HalResource and Link instances using the new constructors
HalUtil - Class in io.wcm.caravan.hal.resource.util
Utility class for HAL resources.
has(String) - Method in class io.wcm.caravan.hal.resource.util.HalCuriAugmenter
Deprecated.
 
hasEmbedded(String) - Method in class io.wcm.caravan.hal.resource.HalResource
 
hashCode() - Method in class io.wcm.caravan.hal.resource.Link
 
hasLink(String) - Method in class io.wcm.caravan.hal.resource.HalResource
 

I

io.wcm.caravan.hal.resource - package io.wcm.caravan.hal.resource
HAL resource bean representations.
io.wcm.caravan.hal.resource.util - package io.wcm.caravan.hal.resource.util
HAL resource utilities.
isTemplated() - Method in class io.wcm.caravan.hal.resource.Link
 

L

link(String, String) - Method in class io.wcm.caravan.hal.resource.util.HalBuilder
Deprecated.
 
link(String, String, String) - Method in class io.wcm.caravan.hal.resource.util.HalBuilder
Deprecated.
 
link(String, String, String, String) - Method in class io.wcm.caravan.hal.resource.util.HalBuilder
Deprecated.
 
Link - Class in io.wcm.caravan.hal.resource
Bean representation of a HAL link.
Link(JsonNode) - Constructor for class io.wcm.caravan.hal.resource.Link
 
Link(ObjectNode) - Constructor for class io.wcm.caravan.hal.resource.Link
 
Link(String) - Constructor for class io.wcm.caravan.hal.resource.Link
Creates a link with a new model that only contains the given URI
LINK_RELATION_CURIES - Static variable in class io.wcm.caravan.hal.resource.util.HalCuriAugmenter
Deprecated.
HAL specific relation for CURI links.

R

register(Link) - Method in class io.wcm.caravan.hal.resource.util.HalCuriAugmenter
Deprecated.
Registers a CURI link.
register(String, String) - Method in class io.wcm.caravan.hal.resource.util.HalCuriAugmenter
Deprecated.
Registers a CURI link by the given name and HREF.
remove() - Method in class io.wcm.caravan.hal.resource.Link
Removes this link from its context resource's JSON representation
removeEmbedded() - Method in class io.wcm.caravan.hal.resource.HalResource
Removes all embedded resources.
removeEmbedded(String) - Method in class io.wcm.caravan.hal.resource.HalResource
Removes all embedded resources for the given relation.
removeEmbedded(String, int) - Method in class io.wcm.caravan.hal.resource.HalResource
Removes one embedded resource for the given relation and index.
removeLink(String, int) - Method in class io.wcm.caravan.hal.resource.HalResource
Removes one link for the given relation and index.
removeLinks() - Method in class io.wcm.caravan.hal.resource.HalResource
Removes all links.
removeLinks(String) - Method in class io.wcm.caravan.hal.resource.HalResource
Removes all links for the given relation.
removeLinkWithHref(String, String) - Method in class io.wcm.caravan.hal.resource.HalResource
Remove the link with the given relation and href
removeState() - Method in class io.wcm.caravan.hal.resource.HalResource
Removes all state attributes
renameEmbedded(String, String) - Method in class io.wcm.caravan.hal.resource.HalResource
Changes the rel of embedded resources

S

setDeprecation(String) - Method in class io.wcm.caravan.hal.resource.Link
 
setEmbedded(String, HalResource) - Method in class io.wcm.caravan.hal.resource.HalResource
Embed resource for the given relation.
setHref(String) - Method in class io.wcm.caravan.hal.resource.Link
 
setHreflang(String) - Method in class io.wcm.caravan.hal.resource.Link
 
setLink(Link) - Method in class io.wcm.caravan.hal.resource.HalResource
Sets link for the self relation.
setLink(String, Link) - Method in class io.wcm.caravan.hal.resource.HalResource
Sets link for the given relation.
setName(String) - Method in class io.wcm.caravan.hal.resource.Link
 
setProfile(String) - Method in class io.wcm.caravan.hal.resource.Link
 
setTemplated(boolean) - Method in class io.wcm.caravan.hal.resource.Link
 
setTitle(String) - Method in class io.wcm.caravan.hal.resource.Link
 
setType(String) - Method in class io.wcm.caravan.hal.resource.Link
 

U

unregister(String) - Method in class io.wcm.caravan.hal.resource.util.HalCuriAugmenter
Deprecated.
Unregisters a CURI link.
A B C E G H I L R S U 
All Classes All Packages