Index (edison-hal 2.1.0 API)

A B C D E F G H I L M N O P R S T U V W Z

A

add(Links) - Method in class de.otto.edison.hal.HalRepresentation: Add links to the HalRepresentation.
always() - Static method in class de.otto.edison.hal.LinkPredicates: Returns a Predicate that is matching every link.
apply(Link) - Method in interface de.otto.edison.hal.traverson.LinkResolver: Resolves an absolute link and returns the linked resource representation as a String.
apply(Traverson) - Method in interface de.otto.edison.hal.traverson.PageHandler: Processes a single page and decides whether or not to proceed to the following page.
array(Link, Link...) - Method in class de.otto.edison.hal.Links.Builder: Adds one or more Links.
array(List<Link>) - Method in class de.otto.edison.hal.Links.Builder: Adds a list of links to the builder that will be rendered as an array of link-objects Equivalent links are NOT added but silently ignored.
as(Class<T>) - Method in class de.otto.edison.hal.HalParser: Specify the type that is used to parse and map the json.
as(Class<T>, EmbeddedTypeInfo, EmbeddedTypeInfo...) - Method in class de.otto.edison.hal.HalParser: Parse embedded items of a given link-relation type not as HalRepresentation, but as a sub-type of HalRepresentation, so extra attributes of the embedded items can be accessed.
as(Class<T>, List<EmbeddedTypeInfo>) - Method in class de.otto.edison.hal.HalParser: Parse embedded items of a given link-relation type not as HalRepresentation, but as a sub-type of HalRepresentation, so extra attributes of the embedded items can be accessed.

B

build() - Method in class de.otto.edison.hal.Embedded.Builder: Builds an Embedded instance.
build() - Method in class de.otto.edison.hal.Link.Builder: Builds the Link instance.
build() - Method in class de.otto.edison.hal.Links.Builder: Creates a Links instance from all added links.
Builder() - Constructor for class de.otto.edison.hal.Embedded.Builder
Builder() - Constructor for class de.otto.edison.hal.Links.Builder

C

collection(String) - Static method in class de.otto.edison.hal.Link: Create a 'collection' link from a href If href is an URI template, the created link is templated and Link.templated will be true.
collection(String) - Method in class de.otto.edison.hal.Links.Builder: Adds a single link with link-relation type 'collection' to the builder.
copyOf(Curies) - Static method in class de.otto.edison.hal.Curies: Returns a copy of another Curies instance.
copyOf(Embedded) - Static method in class de.otto.edison.hal.Embedded.Builder: Creates an EmbeddedBuilder initialized from a copy of an Embedded instance.
copyOf(Link) - Static method in class de.otto.edison.hal.Link: Create a Builder instance and initialize it from a prototype Link.
copyOf(Links) - Static method in class de.otto.edison.hal.Links: Factory method used to build a Links.Builder that is initialized from a prototype Links instance.
curi(String, String) - Static method in class de.otto.edison.hal.Link: Create a 'curies' link (compact URI) with name and a URI template for the link-relation type.
curi(String, String) - Method in class de.otto.edison.hal.Links.Builder: Adds a 'curies' link (compact URI) with name and a URI template for the link-relation type.
curiedRelFrom(String) - Method in class de.otto.edison.hal.CuriTemplate: Returns the rel in CURIED format.
Curies - Class in de.otto.edison.hal: Helper class used to resolve CURIs in links and embedded items.
curies(Links) - Static method in class de.otto.edison.hal.Curies: Creates Curies from some Links.
curies(List<Link>) - Static method in class de.otto.edison.hal.Curies: Creates Curies from a list of CURI links.
CuriTemplate - Class in de.otto.edison.hal: A utility class used to handle user-defined link-relation types and CURI templates.
curiTemplateFor(Link) - Static method in class de.otto.edison.hal.CuriTemplate: Creates a CuriTemplate from a CURI Link.

D

de.otto.edison.hal - package de.otto.edison.hal
de.otto.edison.hal.paging - package de.otto.edison.hal.paging
de.otto.edison.hal.traverson - package de.otto.edison.hal.traverson
DEFAULT_JSON_MAPPER - Static variable in class de.otto.edison.hal.HalParser: The Jackson ObjectMapper that is used to parse application/hal+json documents if not other instance is specified explicitly.
DEFAULT_JSON_MAPPER - Static variable in class de.otto.edison.hal.traverson.Traverson
deserialize(JsonParser, DeserializationContext) - Method in class de.otto.edison.hal.Embedded.EmbeddedDeserializer
deserialize(JsonParser, DeserializationContext) - Method in class de.otto.edison.hal.Links.LinksDeserializer

E

Embedded - Class in de.otto.edison.hal: The embedded items of a HalResource.
embedded(String, HalRepresentation) - Static method in class de.otto.edison.hal.Embedded: Create an Embedded instance with a single embedded HalRepresentations that will be rendered as a single item instead of an array of embedded items.
embedded(String, List<? extends HalRepresentation>) - Static method in class de.otto.edison.hal.Embedded: Create an Embedded instance with a list of nested HalRepresentations for a single link-relation type.
Embedded.Builder - Class in de.otto.edison.hal
Embedded.EmbeddedDeserializer - Class in de.otto.edison.hal: The Jackson JsonDeserializer used to deserialize JSON into Embedded instances.
Embedded.EmbeddedSerializer - Class in de.otto.edison.hal: The Jackson JsonSerializer used to serialize Embedded instances to JSON.
embeddedBuilder() - Static method in class de.otto.edison.hal.Embedded: Create a linksBuilder used to build Embedded instances with more than one link-relation type.
EmbeddedDeserializer() - Constructor for class de.otto.edison.hal.Embedded.EmbeddedDeserializer
EmbeddedSerializer() - Constructor for class de.otto.edison.hal.Embedded.EmbeddedSerializer
EmbeddedTypeInfo - Class in de.otto.edison.hal: Type information for embedded items.
emptyCuries() - Static method in class de.otto.edison.hal.Curies: Creates an empty Curies without curi links.
emptyEmbedded() - Static method in class de.otto.edison.hal.Embedded: Create an empty embedded instance, without embedded items.
emptyLinks() - Static method in class de.otto.edison.hal.Links: Factory method used to create an empty Links instance.
equals(Object) - Method in class de.otto.edison.hal.Curies
equals(Object) - Method in class de.otto.edison.hal.Embedded
equals(Object) - Method in class de.otto.edison.hal.HalRepresentation
equals(Object) - Method in class de.otto.edison.hal.Link
equals(Object) - Method in class de.otto.edison.hal.Links
expand(String) - Method in class de.otto.edison.hal.Curies
expandedRelFrom(String) - Method in class de.otto.edison.hal.CuriTemplate: Returns the rel in expanded format.

F

follow(String) - Method in class de.otto.edison.hal.traverson.Traverson: Follow the first Link of the current resource, selected by its link-relation type.
follow(String, Predicate<Link>) - Method in class de.otto.edison.hal.traverson.Traverson: Follow the first Link of the current resource that is matching the link-relation type and the predicate.
follow(List<String>) - Method in class de.otto.edison.hal.traverson.Traverson: Follow multiple link-relation types, one by one.
follow(List<String>, Predicate<Link>) - Method in class de.otto.edison.hal.traverson.Traverson: Follow multiple link-relation types, one by one, and select the links using the specified predicate.
follow(List<String>, Map<String, Object>) - Method in class de.otto.edison.hal.traverson.Traverson: Follow multiple link-relation types, one by one.
follow(List<String>, Predicate<Link>, Map<String, Object>) - Method in class de.otto.edison.hal.traverson.Traverson: Follow multiple link-relation types, one by one.
follow(String, Map<String, Object>) - Method in class de.otto.edison.hal.traverson.Traverson: Follow the first Link of the current resource, selected by its link-relation type.
follow(String, Predicate<Link>, Map<String, Object>) - Method in class de.otto.edison.hal.traverson.Traverson: Follow the first Link of the current resource, selected by its link-relation type.
followLink(String) - Method in class de.otto.edison.hal.traverson.Traverson: Follow the first Link of the current resource, selected by its link-relation type.
followLink(String, Predicate<Link>) - Method in class de.otto.edison.hal.traverson.Traverson: Follow the first Link of the current resource that is matching the link-relation type and the predicate.
followLink(String, Map<String, Object>) - Method in class de.otto.edison.hal.traverson.Traverson: Follow the first Link of the current resource, selected by its link-relation type.
followLink(String, Predicate<Link>, Map<String, Object>) - Method in class de.otto.edison.hal.traverson.Traverson: Follow the first Link of the current resource, selected by its link-relation type.

G

getAttribute(String) - Method in class de.otto.edison.hal.HalRepresentation: Returns the value of an extra attribute as a JsonNode, or null if no such attribute is present.
getAttributes() - Method in class de.otto.edison.hal.HalRepresentation: Returns extra attributes that were not mapped to properties of the HalRepresentation.
getCuri() - Method in class de.otto.edison.hal.CuriTemplate: Returns the curi Link of this template.
getCuries() - Method in class de.otto.edison.hal.Curies
getCurrentContextUrl() - Method in class de.otto.edison.hal.traverson.Traverson: Returns the current contextUrl of the Traverson.
getDeprecation() - Method in class de.otto.edison.hal.Link: Returns the deprecation information, or an empty string, if the link is not deprecated.
getEmbedded() - Method in class de.otto.edison.hal.HalRepresentation: Returns the Embedded objects of the HalRepresentation.
getHref() - Method in class de.otto.edison.hal.Link: Returns the href of the link.
getHrefAsTemplate() - Method in class de.otto.edison.hal.Link: Returns the href of the link as a UriTemplate that can be expanded by providing the required template variables.
getHreflang() - Method in class de.otto.edison.hal.Link: Returns the hreflang of the link, or an empty String if no hreflang is specified.
getItemsBy(String) - Method in class de.otto.edison.hal.Embedded: Returns the embedded items by link-relation type.
getItemsBy(String, Class<E>) - Method in class de.otto.edison.hal.Embedded: Returns the embedded items by link-relation type.
getLastPage() - Method in class de.otto.edison.hal.paging.NumberedPaging: Returns number of the last page, or Optional.empty() if NumberedPaging.getTotal() is unknown / empty.
getLimit() - Method in class de.otto.edison.hal.paging.SkipLimitPaging: The limit for the current page size.
getLinkBy(String) - Method in class de.otto.edison.hal.Links: Returns the first (if any) link having the specified link-relation type.
getLinkBy(String, Predicate<Link>) - Method in class de.otto.edison.hal.Links: Returns the first (if any) link having the specified link-relation type and matching the given predicate.
getLinks() - Method in class de.otto.edison.hal.HalRepresentation: Returns the Links of the HalRepresentation.
getLinksBy(String) - Method in class de.otto.edison.hal.Links: Returns the list of links having the specified link-relation type.
getLinksBy(String, Predicate<Link>) - Method in class de.otto.edison.hal.Links: Returns the list of links having the specified link-relation type and matching the given predicate.
getName() - Method in class de.otto.edison.hal.Link: Returns the name of the link, or an empty String if no name is specified.
getNestedTypeInfo() - Method in class de.otto.edison.hal.EmbeddedTypeInfo
getPageNumber() - Method in class de.otto.edison.hal.paging.NumberedPaging
getPageSize() - Method in class de.otto.edison.hal.paging.NumberedPaging
getProfile() - Method in class de.otto.edison.hal.Link: Returns the profile of the link, or an empty String if no profile is specified.
getRel() - Method in class de.otto.edison.hal.EmbeddedTypeInfo
getRel() - Method in class de.otto.edison.hal.Link: Returns the link-relation type of the link.
getRels() - Method in class de.otto.edison.hal.Embedded: Returns all link-relation types of the embedded items.
getRels() - Method in class de.otto.edison.hal.Links: Returns all link-relation types of the embedded items.
getResource() - Method in class de.otto.edison.hal.traverson.Traverson: Return the selected resource as HalRepresentation.
getResourceAs(Class<T>) - Method in class de.otto.edison.hal.traverson.Traverson: Return the selected resource and return it in the specified type.
getResourceAs(Class<T>, EmbeddedTypeInfo, EmbeddedTypeInfo...) - Method in class de.otto.edison.hal.traverson.Traverson: Return the selected resource and return it in the specified type.
getResourceAs(Class<T>, List<EmbeddedTypeInfo>) - Method in class de.otto.edison.hal.traverson.Traverson: Return the selected resource and return it in the specified type.
getSkip() - Method in class de.otto.edison.hal.paging.SkipLimitPaging: Skipped number of items in the current selection.
getTitle() - Method in class de.otto.edison.hal.Link: Returns the title of the link, or an empty String if no title is specified.
getTotal() - Method in class de.otto.edison.hal.paging.NumberedPaging: The optional total number of available items in the current selection.
getTotal() - Method in class de.otto.edison.hal.paging.SkipLimitPaging: Optional total number of items in the current selection.
getType() - Method in class de.otto.edison.hal.EmbeddedTypeInfo
getType() - Method in class de.otto.edison.hal.Link: Returns the type of the link, or an empty String if no type is specified.

H

HalParser - Class in de.otto.edison.hal: A parser used to parse application/hal+json representations of REST resources into Java objects.
HalRepresentation - Class in de.otto.edison.hal: Representation used to parse and create HAL+JSON documents from Java classes.
HalRepresentation() - Constructor for class de.otto.edison.hal.HalRepresentation
HalRepresentation(Links) - Constructor for class de.otto.edison.hal.HalRepresentation: Creates a HalRepresentation having Links
HalRepresentation(Links, Curies) - Constructor for class de.otto.edison.hal.HalRepresentation: Deprecated.
This method will most likely not be required by any users of edison-hal. Please contact me, if you need this, otherwise the constructor will be removed in 3.0.0
HalRepresentation(Links, Embedded) - Constructor for class de.otto.edison.hal.HalRepresentation: Creates a HalRepresentation with Links and Embedded objects.
HalRepresentation(Links, Embedded, Curies) - Constructor for class de.otto.edison.hal.HalRepresentation: Deprecated.
This method will most likely not be required by any users of edison-hal. Please contact me, if you need this, otherwise the constructor will be removed in 3.0.0
hashCode() - Method in class de.otto.edison.hal.Curies
hashCode() - Method in class de.otto.edison.hal.Embedded
hashCode() - Method in class de.otto.edison.hal.HalRepresentation
hashCode() - Method in class de.otto.edison.hal.Link
hashCode() - Method in class de.otto.edison.hal.Links
hasItem(String) - Method in class de.otto.edison.hal.Embedded: Checks the existence of embedded items with link-relation type rel
hasLink(String) - Method in class de.otto.edison.hal.Links: Checks the existence of a link with link-relation type rel
hasMore() - Method in class de.otto.edison.hal.paging.NumberedPaging
hasMore() - Method in class de.otto.edison.hal.paging.SkipLimitPaging
havingName(String) - Static method in class de.otto.edison.hal.LinkPredicates: Returns a Predicate that is matching links having the specified name name
havingProfile(String) - Static method in class de.otto.edison.hal.LinkPredicates: Returns a Predicate that is matching links having the specified profile profile
havingType(String) - Static method in class de.otto.edison.hal.LinkPredicates: Returns a Predicate that is matching links having the specified type type
hops(String, String...) - Static method in class de.otto.edison.hal.traverson.Traverson: Creates a list of link-relation types used to follow multiple hops, optionally using uri template variables.

I

isArray(String) - Method in class de.otto.edison.hal.Embedded: Returns true if there is at least one embedded item with link-relation type rel, and if the item will be rendered as an array of embedded items instead of a single object.
isArray(String) - Method in class de.otto.edison.hal.Links: Returns true if there is at least one link with link-relation type rel, and if the link will be rendered as an array of link-objects.
isEmpty() - Method in class de.otto.edison.hal.Embedded
isEmpty() - Method in class de.otto.edison.hal.Links
isEquivalentTo(Link) - Method in class de.otto.edison.hal.Link: Two links are considerered equivalent, if they have the same link-relation type and are pointing to the same resource in the same representation and profile.
isMatching(String) - Method in class de.otto.edison.hal.CuriTemplate: Returns true, if the given link-relation type is matching the CuriTemplate pattern, false if not.
isMatchingCuriedRel(String) - Method in class de.otto.edison.hal.CuriTemplate: Returns true, if the given link-relation type is a CURI rel matching the CuriTemplate pattern, false if not.
isMatchingExpandedRel(String) - Method in class de.otto.edison.hal.CuriTemplate: Returns true, if the given link-relation type is a non-CURI rel matching the CuriTemplate pattern, false if not.
isTemplated() - Method in class de.otto.edison.hal.Link: Returns true, if the link is templated, false otherwise.
item(String) - Static method in class de.otto.edison.hal.Link: Create a 'item' link from a href.
item(String) - Method in class de.otto.edison.hal.Links.Builder: Adds an 'item' link to the builder.

L

LIMIT_VAR - Static variable in class de.otto.edison.hal.paging.SkipLimitPaging: The default template-variable name used to identify the number of items per page
limitVar() - Method in class de.otto.edison.hal.paging.SkipLimitPaging: Return the name of the template variable used to specify the size of the page.
Link - Class in de.otto.edison.hal: A link to a REST resource.
link(String, String) - Static method in class de.otto.edison.hal.Link: Create a link from a link-relation type and href.
Link.Builder - Class in de.otto.edison.hal: A Builder used to build complex links.
linkBuilder(String, String) - Static method in class de.otto.edison.hal.Link: Create a Builder instance with mandatory link-relation type and href If href is an URI template, the link created by the Builder will be templated.
linkingTo() - Static method in class de.otto.edison.hal.Links
LinkPredicates - Class in de.otto.edison.hal: Predicates used to select links matching some criteria.
LinkResolver - Interface in de.otto.edison.hal.traverson: Functional interface used to resolve a Link and return the application/hal+json resource as a String.
Links - Class in de.otto.edison.hal: Representation of a number of HAL _links.
links(UriTemplate, EnumSet<PagingRel>) - Method in class de.otto.edison.hal.paging.NumberedPaging: Return the requested links for a paged resource were the link's hrefs are created using the given UriTemplate.
links(UriTemplate, EnumSet<PagingRel>) - Method in class de.otto.edison.hal.paging.SkipLimitPaging: Return the requested links for a paged resource were the link's hrefs are created using the given UriTemplate.
Links.Builder - Class in de.otto.edison.hal: A Builder used to build Links instances.
Links.LinksDeserializer - Class in de.otto.edison.hal: A Jackson JsonDeserializer for Links.
Links.LinksSerializer - Class in de.otto.edison.hal: A Jackson JsonSerializer for Links.
LinksDeserializer() - Constructor for class de.otto.edison.hal.Links.LinksDeserializer
LinksSerializer() - Constructor for class de.otto.edison.hal.Links.LinksSerializer

M

matchingCuriTemplateFor(List<Link>, String) - Static method in class de.otto.edison.hal.CuriTemplate: Returns an optional CuriTemplate that is matching the rel parameter, or empty if no matching CURI is found.
mergeWith(Curies) - Method in class de.otto.edison.hal.Curies: Merges this Curies with another instance of Curies and returns the merged instance.

N

NumberedPaging - Class in de.otto.edison.hal.paging: A helper class used to create paging links for paged resources that are using numbered page URIs.
NumberedPaging(int, int, int, boolean) - Constructor for class de.otto.edison.hal.paging.NumberedPaging: Creates a NumberedPage instance.
NumberedPaging(int, int, int, int) - Constructor for class de.otto.edison.hal.paging.NumberedPaging: Creates a NumberedPage instance.

O

oneBasedNumberedPaging(int, int, boolean) - Static method in class de.otto.edison.hal.paging.NumberedPaging: Create a NumberedPaging instances for pages where paging starts with one and it is known whether or not there are more items beyond the current page.
oneBasedNumberedPaging(int, int, int) - Static method in class de.otto.edison.hal.paging.NumberedPaging: Create a NumberedPaging instances for pages where paging starts with one and it is known how many items are matching the initial query.
optionallyHavingName(String) - Static method in class de.otto.edison.hal.LinkPredicates: Returns a Predicate that is matching links having the specified name name, or no name at all.
optionallyHavingProfile(String) - Static method in class de.otto.edison.hal.LinkPredicates: Returns a Predicate that is matching links having the specified profile profile, or no profile at all.
optionallyHavingType(String) - Static method in class de.otto.edison.hal.LinkPredicates: Returns a Predicate that is matching links having the specified type type, or no type at all.

P

PAGE_NUMBER_VAR - Static variable in class de.otto.edison.hal.paging.NumberedPaging: The default template-variable name used to identify the number of the page.
PAGE_SIZE_VAR - Static variable in class de.otto.edison.hal.paging.NumberedPaging: The default template-variable name used to identify the size of the page.
PageHandler - Interface in de.otto.edison.hal.traverson: Functional interface used to traverse pages of linked or embedded resources.
pageNumberVar() - Method in class de.otto.edison.hal.paging.NumberedPaging: The name of the uri-template variable used to identify the current page number.
pageSizeVar() - Method in class de.otto.edison.hal.paging.NumberedPaging: The name of the uri-template variable used to specify the current page size.
paginate(String, EmbeddedTypeInfo, PageHandler) - Method in class de.otto.edison.hal.traverson.Traverson: Iterates over pages by following {code rel} links.
paginateAs(String, Class<T>, EmbeddedTypeInfo, PageHandler) - Method in class de.otto.edison.hal.traverson.Traverson: Iterates over pages by following {code rel} links.
paginateNext(PageHandler) - Method in class de.otto.edison.hal.traverson.Traverson: Iterates over pages by following 'next' links.
paginateNext(EmbeddedTypeInfo, PageHandler) - Method in class de.otto.edison.hal.traverson.Traverson: Iterates over pages by following 'next' links.
paginateNextAs(Class<T>, PageHandler) - Method in class de.otto.edison.hal.traverson.Traverson: Iterates over pages by following 'next' links.
paginateNextAs(Class<T>, EmbeddedTypeInfo, PageHandler) - Method in class de.otto.edison.hal.traverson.Traverson: Iterates over pages by following 'next' links.
paginatePrev(PageHandler) - Method in class de.otto.edison.hal.traverson.Traverson: Iterates over pages by following 'prev' links.
paginatePrev(EmbeddedTypeInfo, PageHandler) - Method in class de.otto.edison.hal.traverson.Traverson: Iterates over pages by following 'prev' links.
paginatePrevAs(Class<T>, PageHandler) - Method in class de.otto.edison.hal.traverson.Traverson: Iterates over pages by following 'prev' links.
paginatePrevAs(Class<T>, EmbeddedTypeInfo, PageHandler) - Method in class de.otto.edison.hal.traverson.Traverson: Iterates over pages by following 'prev' links.
PagingRel - Enum in de.otto.edison.hal.paging: Link-relation types used in paged resources.
parse(String) - Static method in class de.otto.edison.hal.HalParser: Create a new HalParser for a JSON document.
parse(String, ObjectMapper) - Static method in class de.otto.edison.hal.HalParser: Create a new HalParser for a JSON document.
profile(String) - Static method in class de.otto.edison.hal.Link: Create a 'profile' link from a href

R

register(Link) - Method in class de.otto.edison.hal.Curies: Registers a CURI link in the Curies instance.
relPlaceHolderFrom(String) - Method in class de.otto.edison.hal.CuriTemplate: Returns the placeholder from a link-relation type that is matching the CuriTemplate.
remove(String) - Method in class de.otto.edison.hal.Links: Removes the links with link-relation type rel from the Links object.
replace(String, List<Link>) - Method in class de.otto.edison.hal.Links.Builder: Replaces the link(s) currently associated with rel by a list of links to the builder that will be rendered as an array of link-objects.
resolve(String) - Method in class de.otto.edison.hal.Curies: Resolves a link-relation type (curied or full rel) and returns the curied form, or the unchanged rel, if no matching CURI is registered.

S

self(String) - Static method in class de.otto.edison.hal.Link: Create a 'self' link from a href.
self(String) - Method in class de.otto.edison.hal.Links.Builder: Adds a 'self' link and returns the Builder.
serialize(Embedded, JsonGenerator, SerializerProvider) - Method in class de.otto.edison.hal.Embedded.EmbeddedSerializer
serialize(Links, JsonGenerator, SerializerProvider) - Method in class de.otto.edison.hal.Links.LinksSerializer
single(Link, Link...) - Method in class de.otto.edison.hal.Links.Builder: Adds one or more link to the builder that will be rendered as a single link-object instead of an array of link-objects.
single(List<Link>) - Method in class de.otto.edison.hal.Links.Builder: Adds a list of links to the builder that will be rendered as a single link-object instead of an array of link-objects.
SKIP_VAR - Static variable in class de.otto.edison.hal.paging.SkipLimitPaging: The default template-variable name used to identify the number of items to skip
skipLimitPage(int, int, boolean) - Static method in class de.otto.edison.hal.paging.SkipLimitPaging: Create a NumberedPaging instances for pages where it is known whether or not there are more items beyond the current page.
skipLimitPage(int, int, int) - Static method in class de.otto.edison.hal.paging.SkipLimitPaging: Create a NumberedPaging instances for pages where it is known how many items are matching the initial query.
SkipLimitPaging - Class in de.otto.edison.hal.paging: A helper class used to create paging links for paged resources that are using page URIs with skip and limit paramters.
SkipLimitPaging(int, int, boolean) - Constructor for class de.otto.edison.hal.paging.SkipLimitPaging: Creates a NumberedPage instance.
SkipLimitPaging(int, int, int) - Constructor for class de.otto.edison.hal.paging.SkipLimitPaging: Creates a NumberedPage instance.
skipVar() - Method in class de.otto.edison.hal.paging.SkipLimitPaging: Return the name of the template variable used to specify the number of skipped items.
startWith(String, Map<String, Object>) - Method in class de.otto.edison.hal.traverson.Traverson: Start traversal at the application/hal+json resource idenfied by uri.
startWith(String) - Method in class de.otto.edison.hal.traverson.Traverson: Start traversal at the application/hal+json resource idenfied by uri.
startWith(HalRepresentation) - Method in class de.otto.edison.hal.traverson.Traverson: Start traversal at the given HAL resource.
startWith(URL, HalRepresentation) - Method in class de.otto.edison.hal.traverson.Traverson: Start traversal at the given HAL resource, using the contextUrl to resolve relative links.
stream() - Method in class de.otto.edison.hal.Links: Returns a Stream of links.
stream() - Method in class de.otto.edison.hal.traverson.Traverson: Follow the Links of the current resource, selected by its link-relation type and returns a Stream containing the returned HalRepresentations.
streamAs(Class<T>) - Method in class de.otto.edison.hal.traverson.Traverson: Follow the Links of the current resource, selected by its link-relation type and returns a Stream containing the returned HalRepresentations.
streamAs(Class<T>, EmbeddedTypeInfo, EmbeddedTypeInfo...) - Method in class de.otto.edison.hal.traverson.Traverson: Follow the Links of the current resource, selected by its link-relation type and returns a Stream containing the returned HalRepresentations.
streamAs(Class<T>, List<EmbeddedTypeInfo>) - Method in class de.otto.edison.hal.traverson.Traverson: Follow the Links of the current resource, selected by its link-relation type and returns a Stream containing the returned HalRepresentations.

T

toString() - Method in class de.otto.edison.hal.Curies
toString() - Method in class de.otto.edison.hal.Embedded
toString() - Method in class de.otto.edison.hal.EmbeddedTypeInfo
toString() - Method in class de.otto.edison.hal.HalRepresentation
toString() - Method in class de.otto.edison.hal.Link
toString() - Method in class de.otto.edison.hal.Links
toString() - Method in enum de.otto.edison.hal.paging.PagingRel: Returns a link-relation type in lower-case format so it is usable in 'rel' attributes of Links
Traverson - Class in de.otto.edison.hal.traverson: A Traverson is a utility that makes it easy to navigate REST APIs using HAL+JSON.
traverson(LinkResolver) - Static method in class de.otto.edison.hal.traverson.Traverson: Create a Traverson that is using the given Function to resolve a Link and return a HAL+JSON document.
traverson(LinkResolver, ObjectMapper) - Static method in class de.otto.edison.hal.traverson.Traverson: Create a Traverson that is using the given Function to resolve a Link and return a HAL+JSON document.

U

using(Curies) - Method in class de.otto.edison.hal.Embedded.Builder
using(Curies) - Method in class de.otto.edison.hal.Embedded
using(Curies) - Method in class de.otto.edison.hal.Links.Builder

V

valueOf(String) - Static method in enum de.otto.edison.hal.paging.PagingRel: Returns the enum constant of this type with the specified name.
values() - Static method in enum de.otto.edison.hal.paging.PagingRel: Returns an array containing the constants of this enum type, in the order they are declared.

W

with(String, List<? extends HalRepresentation>) - Method in class de.otto.edison.hal.Embedded.Builder: Adds / replaces the embedded representations for a link-relation type.
with(String, HalRepresentation) - Method in class de.otto.edison.hal.Embedded.Builder: Adds / replaces the embedded representation for a link-relation type.
with(Links) - Method in class de.otto.edison.hal.Links.Builder: Adds all links from Links to the builder.
withDeprecation(String) - Method in class de.otto.edison.hal.Link.Builder: Set deprecation attribute.
withEmbedded(String, Class<? extends HalRepresentation>, EmbeddedTypeInfo...) - Static method in class de.otto.edison.hal.EmbeddedTypeInfo
withEmbedded(String, Class<? extends HalRepresentation>, List<EmbeddedTypeInfo>) - Static method in class de.otto.edison.hal.EmbeddedTypeInfo
withEmbedded(String, List<? extends HalRepresentation>) - Method in class de.otto.edison.hal.HalRepresentation: Adds embedded items for a link-relation type to the HalRepresentation.
withEmbedded(String, HalRepresentation) - Method in class de.otto.edison.hal.HalRepresentation: Adds an embedded item for a link-relation type to the HalRepresentation.
withHref(String) - Method in class de.otto.edison.hal.Link.Builder: Set the href of the linked resource If href is an URI template, the created link is templated and Link.templated will be true.
withHrefLang(String) - Method in class de.otto.edison.hal.Link.Builder: Set the language of the linked resource
withName(String) - Method in class de.otto.edison.hal.Link.Builder: Set the name attribute.
without(String) - Method in class de.otto.edison.hal.Embedded.Builder: Removes the embedded representations for a link-relation type.
without(String) - Method in class de.otto.edison.hal.Links.Builder: Removes registered links from the builder.
withProfile(String) - Method in class de.otto.edison.hal.Link.Builder: Set the profile attribute
withRel(String) - Method in class de.otto.edison.hal.Link.Builder: Set the rel of the linked resource
withTitle(String) - Method in class de.otto.edison.hal.Link.Builder: Set the title attribute
withType(String) - Method in class de.otto.edison.hal.Link.Builder: Set the media type of the linked resource
withVars(String, Object, Object...) - Static method in class de.otto.edison.hal.traverson.Traverson: Creates a Map containing key-value pairs used as parameters for UriTemplate variables.

Z

zeroBasedNumberedPaging(int, int, boolean) - Static method in class de.otto.edison.hal.paging.NumberedPaging: Create a NumberedPaging instances for pages where paging starts with zero and it is known whether or not there are more items beyond the current page.
zeroBasedNumberedPaging(int, int, int) - Static method in class de.otto.edison.hal.paging.NumberedPaging: Create a NumberedPaging instances for pages where paging starts with zero and it is known how many items are matching the initial query.

A B C D E F G H I L M N O P R S T U V W Z