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

A

ABOUT - Static variable in class siren.Relation

Refers to a resource that is the subject of the link's context.

Action - Class in siren

Represents an available behavior an entity exposes.

action(Action) - Method in class siren.EmbeddedRepresentationSubEntity.Builder

Adds the action provided to the current state of the builder.

action(Action) - Method in class siren.Entity.Builder

Adds the action provided to the current state of the builder.

Action.Builder - Class in siren

Constructs an instance of Action.Builder.

ActionBuilderFactory - Class in siren.factories

Constructs instances of Action.Builder.

ActionBuilderFactory() - Constructor for class siren.factories.ActionBuilderFactory

Constructs an instance ActionBuilderFactory.

actions(Action...) - Method in class siren.EmbeddedRepresentationSubEntity.Builder

Adds the actions provided to the current state of the builder.

actions(Action...) - Method in class siren.Entity.Builder

Adds the actions provided to the current state of the builder.

ALTERNATE - Static variable in class siren.Relation

Refers to a substitute for this context.

APPENDIX - Static variable in class siren.Relation

Refers to an appendix.

ARCHIVES - Static variable in class siren.Relation

Refers to a collection of records, documents, or other materials of historical interest.

AUTHOR - Static variable in class siren.Relation

Refers to the context's author.

B

BLOCKED_BY - Static variable in class siren.Relation

Identifies the entity that blocks access to a resource following receipt of a legal demand.

BOOKMARK - Static variable in class siren.Relation

Gives a permanent link to use for bookmarking purposes.

build() - Method in class siren.Action.Builder

Constructs an instance of Action with the current state of the builder.

build() - Method in interface siren.Builder

Constructs an instance of T with the current state of the builder.

build() - Method in class siren.EmbeddedLinkSubEntity.Builder

Constructs an instance of EmbeddedLinkSubEntity with the current state of the builder.

build() - Method in class siren.EmbeddedRepresentationSubEntity.Builder

Constructs an instance with the current state of the builder.

build() - Method in class siren.Entity.Builder

Constructs an instance with the current state of the builder.

build() - Method in class siren.Field.Builder

Constructs an instance of T with the current state of the builder.

build() - Method in class siren.FieldValue.Builder

Constructs an instance of T with the current state of the builder.

build() - Method in class siren.Link.Builder

Constructs a Link instance with the current state of the builder.

Builder() - Constructor for class siren.Action.Builder

Builder<T> - Interface in siren

Defines the contract that all types choosing to be a Builder must abide by.

Builder() - Constructor for class siren.EmbeddedLinkSubEntity.Builder

Constructs an instance of EmbeddedLinkSubEntity.Builder.

Builder() - Constructor for class siren.EmbeddedRepresentationSubEntity.Builder

Constructs an instance of EmbeddedRepresentationSubEntity.Builder.

Builder() - Constructor for class siren.Entity.Builder

Builder() - Constructor for class siren.Field.Builder

Builder() - Constructor for class siren.FieldValue.Builder

Builder() - Constructor for class siren.Link.Builder

Constructs an instance of Link.Builder.

BuilderFactory<T extends Builder> - Interface in siren.factories

Defines the contract that all types choosing to be a BuilderFactory must abide by.

C

CANONICAL - Static variable in class siren.Relation

Designates the preferred version of a resource (the IRI and its contents).

CHAPTER - Static variable in class siren.Relation

Refers to a chapter in a collection of resources.

clear() - Method in class siren.Action.Builder

Clears the state of the builder.

clear() - Method in interface siren.Builder

Clears the state of the builder.

clear() - Method in class siren.EmbeddedLinkSubEntity.Builder

Clears the state of the builder.

clear() - Method in class siren.EmbeddedRepresentationSubEntity.Builder

Clears the state of the builder.

clear() - Method in class siren.Entity.Builder

Clears the state of the builder.

clear() - Method in class siren.Field.Builder

Clears the state of the builder.

clear() - Method in class siren.FieldValue.Builder

Clears the state of the builder.

clear() - Method in class siren.Link.Builder

Clears the state of the builder.

COLLECTION - Static variable in class siren.Relation

The target IRI points to a resource which represents the collection resource for the context IRI.

CONTENTS - Static variable in class siren.Relation

Refers to a table of contents.

CONVERTED_FROM - Static variable in class siren.Relation

The document linked to was later converted to the document that contains this link relation.

COPYRIGHT - Static variable in class siren.Relation

Refers to a copyright statement that applies to the link's context.

create() - Method in class siren.factories.ActionBuilderFactory

Constructs an instance of Action.Builder.

create() - Method in interface siren.factories.BuilderFactory

Constructs an instance of T.

create() - Method in class siren.factories.EmbeddedLinkSubEntityBuilderFactory

Constructs an instance of EmbeddedLinkSubEntity.Builder.

create() - Method in class siren.factories.EmbeddedRepresentationSubEntityBuilderFactory

Constructs an instance of EmbeddedRepresentationSubEntity.Builder.

create() - Method in class siren.factories.EntityBuilderFactory

Constructs an instance of EntityBuilderFactory.

create() - Method in class siren.factories.FieldBuilderFactory

Constructs an instance of Field.Builder.

create() - Method in class siren.factories.LinkBuilderFactory

Constructs an instance of LinkBuilderFactory.

CREATE_FORM - Static variable in class siren.Relation

The target IRI points to a resource where a submission form can be obtained.

CURRENT - Static variable in class siren.Relation

Refers to a resource containing the most recent item(s) in a collection of resources.

D

DESCRIBED_BY - Static variable in class siren.Relation

Refers to a resource providing information about the link's context.

DESCRIBES - Static variable in class siren.Relation

The relationship A 'describes' B asserts that resource A provides a description of resource B.

DISCLOSURE - Static variable in class siren.Relation

Refers to a list of patent disclosures made with respect to material for which 'disclosure' relation is specified.

DNS_PREFETCH - Static variable in class siren.Relation

Used to indicate an origin that will be used to fetch required resources for the link context, and that the user agent ought to resolve as early as possible.

DUPLICATE - Static variable in class siren.Relation

Refers to a resource whose available representations are byte-for-byte identical with the corresponding representations of the context IRI.

E

EDIT - Static variable in class siren.Relation

Refers to a resource that can be used to edit the link's context.

EDIT_FORM - Static variable in class siren.Relation

The target IRI points to a resource where a submission form for editing associated resource can be obtained.

EDIT_MEDIA - Static variable in class siren.Relation

Refers to a resource that can be used to edit media associated with the link's context.

EmbeddedLinkSubEntity - Class in siren

A sub-entity containing an href value.

EmbeddedLinkSubEntity.Builder - Class in siren

Constructs an instance of EmbeddedLinkSubEntity.Builder.

EmbeddedLinkSubEntityBuilderFactory - Class in siren.factories

Constructs instances of EmbeddedLinkSubEntity.Builder.

EmbeddedLinkSubEntityBuilderFactory() - Constructor for class siren.factories.EmbeddedLinkSubEntityBuilderFactory

Constructs an instance of EmbeddedLinkSubEntityBuilderFactory.

EmbeddedRepresentationSubEntity - Class in siren

An embedded entity representation that contains all the characteristics of a typical entity.

EmbeddedRepresentationSubEntity.Builder - Class in siren

Constructs an instance of EmbeddedRepresentationSubEntity.Builder.

EmbeddedRepresentationSubEntityBuilderFactory - Class in siren.factories

Constructs instances of EmbeddedRepresentationSubEntity.Builder.

EmbeddedRepresentationSubEntityBuilderFactory() - Constructor for class siren.factories.EmbeddedRepresentationSubEntityBuilderFactory

Constructs an instance of EmbeddedRepresentationSubEntityBuilderFactory.

ENCLOSURE - Static variable in class siren.Relation

Identifies a related resource that is potentially large and might require special handling.

Entity - Class in siren

An Entity is a URI-addressable resource that has properties and actions associated with it.

Entity.Builder - Class in siren

Constructs instances of Entity.

EntityBase - Class in siren

Represents the common lineage of all entities.

EntityBase() - Constructor for class siren.EntityBase

Constructs an instance of EntityBase.

EntityBase(List<String>, String) - Constructor for class siren.EntityBase

Constructs an instance of EntityBase.

EntityBuilderFactory - Class in siren.factories

Constructs instances of EntityBuilderFactory.

EntityBuilderFactory() - Constructor for class siren.factories.EntityBuilderFactory

Constructs an instance of EntityBuilderFactory.

equals(Object) - Method in class siren.Action

Determines if the instance of Object provided is equal to the calling Action instance.

equals(Object) - Method in class siren.EmbeddedLinkSubEntity

Determines if the instance of Object provided is equal to the calling EmbeddedLinkSubEntity instance.

equals(Object) - Method in class siren.EmbeddedRepresentationSubEntity

Determines if the instance of Object provided is equal to the calling EmbeddedRepresentationSubEntity instance.

equals(Object) - Method in class siren.Entity

Determines if the instance of Object provided is equal to the calling Entity instance.

equals(Object) - Method in class siren.EntityBase

Determines if the instance of Object provided is equal to the calling EntityBase instance.

equals(Object) - Method in class siren.Field

Determines if the instance of Object provided is equal to the calling Field instance.

equals(Object) - Method in class siren.FieldValue

Determines if the instance of Object provided is equal to the calling FieldValue instance.

equals(Object) - Method in class siren.Link

Determines if the instance of Object provided is equal to the calling Link instance.

equals(Object) - Method in class siren.Relation

Determines if the instance of Object provided is equal to the calling Relation instance.

F

field(Field) - Method in class siren.Action.Builder

Adds the field provided to the current state of the builder.

Field<T> - Class in siren

Represents a control inside of an action.

Field.Builder<T> - Class in siren

Constructs an instance of Field.Builder.

FieldBuilderFactory<T> - Class in siren.factories

Constructs instances of Field.Builder.

FieldBuilderFactory() - Constructor for class siren.factories.FieldBuilderFactory

Constructs an instance of FieldBuilderFactory.

fields(Field...) - Method in class siren.Action.Builder

Adds the fields provided to the current state of the builder.

FieldType - Enum in siren

Identifies the possible field types.

FieldValue<T> - Class in siren

Value objects represent multiple selectable field values.

FieldValue.Builder<T> - Class in siren

Constructs an instance of FieldValue.Builder.

FIRST - Static variable in class siren.Relation

An IRI that refers to the furthest preceding resource in a series of resources.

G

getActions() - Method in class siren.Entity

Retrieves the actions.

getEntities() - Method in class siren.Entity

Retrieves the sub-entities.

getFields() - Method in class siren.Action

Retrieves the fields associated with the action.

getHref() - Method in class siren.Action

Retrieves the href of the action.

getHref() - Method in class siren.EmbeddedLinkSubEntity

Retrieves the URI of the linked sub-entity.

getHref() - Method in class siren.Link

Retrieves the URI of the linked resource.

getKlass() - Method in class siren.Action

Retrieves the class for the action.

getKlass() - Method in class siren.EntityBase

Retrieves the class of the entity.

getKlass() - Method in class siren.Link

Retrieves the class for the link.

getLinks() - Method in class siren.Entity

Retrieves the links.

getMethod() - Method in class siren.Action

Retrieves the method of the action.

getName() - Method in class siren.Action

Retrieves the name of the action.

getName() - Method in class siren.Field

Retrieves the name describing the control.

getProperties() - Method in class siren.Entity

Retrieves the properties.

getRel() - Method in class siren.EmbeddedLinkSubEntity

Retrieves the relationship of the sub-entity to its parent, per Web Linking (RFC5899).

getRel() - Method in class siren.EmbeddedRepresentationSubEntity

Retrieves the relationship of the sub-entity to its parent, per Web Linking (RFC5899).

getRel() - Method in class siren.Link

Retrieves the relationship of the link to its entity.

getSelected() - Method in class siren.FieldValue

Retrieves whether this value should be considered preselected.

getTitle() - Method in class siren.Action

Retrieves the title of the action.

getTitle() - Method in class siren.EntityBase

Retrieves the title of the entity.

getTitle() - Method in class siren.Field

Retrieves the textual annotation of a field.

getTitle() - Method in class siren.FieldValue

Retrieves the textual description of a field value.

getTitle() - Method in class siren.Link

Retrieves the title of the link.

getType() - Method in class siren.Action

Retrieves the type of the action.

getType() - Method in class siren.EmbeddedLinkSubEntity

Retrieves the media type of the linked resource, per Web Linking (RFC5988).

getType() - Method in class siren.Field

Retrieves the input type of the field.

getType() - Method in class siren.Link

Retrieves the link's type.

getValue() - Method in class siren.Field

Retrieves the value assigned to the field.

getValue() - Method in class siren.FieldValue

Retrieves the value for the field.

GLOSSARY - Static variable in class siren.Relation

Refers to a glossary of terms.

H

hashCode() - Method in class siren.Action

Generates hashcode represented as an integer for the calling Action instance.

hashCode() - Method in class siren.EmbeddedLinkSubEntity

Generates hashcode represented as an integer for the calling EmbeddedRepresentationSubEntity instance.

hashCode() - Method in class siren.EmbeddedRepresentationSubEntity

Generates hashcode represented as an integer for the calling EmbeddedRepresentationSubEntity instance.

hashCode() - Method in class siren.Entity

Generates hashcode represented as an integer for the calling Entity instance.

hashCode() - Method in class siren.EntityBase

Generates hashcode represented as an integer for the calling EntityBase sub-class instance.

hashCode() - Method in class siren.Field

Generates hashcode represented as an integer for the calling Field instance.

hashCode() - Method in class siren.FieldValue

Generates hashcode represented as an integer for the calling FieldValue instance.

hashCode() - Method in class siren.Link

Generates hashcode represented as an integer for the calling Link instance.

hashCode() - Method in class siren.Relation

Generates hashcode represented as an integer for the calling Relation instance.

HELP - Static variable in class siren.Relation

Refers to context-sensitive help.

HOSTS - Static variable in class siren.Relation

Refers to a resource hosted by the server indicated by the link context.

href(URI) - Method in class siren.Action.Builder

Adds the href provided to the current state of the builder.

href(URI) - Method in class siren.EmbeddedLinkSubEntity.Builder

Adds the href to the current state of the builder.

href(URI) - Method in class siren.Link.Builder

Sets the current state of the builder to have the href provided.

HttpMethod - Enum in siren

Identifies the possible HTTP methods.

HUB - Static variable in class siren.Relation

Refers to a hub that enables registration for notification of updates to the context.

I

ICON - Static variable in class siren.Relation

Refers to an icon representing the link's context.

INDEX - Static variable in class siren.Relation

Refers to an index.

isExtension() - Method in class siren.Relation

Indicates whether the calling Relation instance is an extension relation.

ITEM - Static variable in class siren.Relation

The target IRI points to a resource that is a member of the collection represented by the context IRI.

K

klass(String) - Method in class siren.Action.Builder

Adds the class provided to the current state of the builder.

klass(String) - Method in class siren.EmbeddedLinkSubEntity.Builder

Adds the class provided to the current state of the builder.

klass(String) - Method in class siren.EmbeddedRepresentationSubEntity.Builder

Adds the class provided to the current state of the builder.

klass(String) - Method in class siren.Entity.Builder

Adds the class provided to the current state of the builder.

klass(String) - Method in class siren.Link.Builder

Adds the class provided to the current state of the builder.

klasses(String...) - Method in class siren.Action.Builder

Adds the classes provided to the current state of the builder.

klasses(String...) - Method in class siren.EmbeddedLinkSubEntity.Builder

Adds the classes provided to the current state of the builder.

klasses(String...) - Method in class siren.EmbeddedRepresentationSubEntity.Builder

Adds the classes provided to the current state of the builder.

klasses(String...) - Method in class siren.Entity.Builder

Adds the classes provided to the current state of the builder.

klasses(String...) - Method in class siren.Link.Builder

Adds the classes provided to the current state of the builder.

L

LAST - Static variable in class siren.Relation

An IRI that refers to the furthest following resource in a series of resources.

LATEST_VERSION - Static variable in class siren.Relation

Points to a resource containing the latest (e.g., current) version of the context.

LICENSE - Static variable in class siren.Relation

Refers to a license associated with this context.

link(Link) - Method in class siren.EmbeddedRepresentationSubEntity.Builder

Adds the link provided to the current state of the builder.

link(Link) - Method in class siren.Entity.Builder

Adds the link provided to the current state of the builder.

Link - Class in siren

Represent navigational transitions.

Link.Builder - Class in siren

Constructs instances of Link.

LinkBuilderFactory - Class in siren.factories

Constructs instances of Link.Builder.

LinkBuilderFactory() - Constructor for class siren.factories.LinkBuilderFactory

Constructs an instance of LinkBuilderFactory.

links(Link...) - Method in class siren.EmbeddedRepresentationSubEntity.Builder

Adds the links provided to the current state of the builder.

links(Link...) - Method in class siren.Entity.Builder

Adds the links provided to the current state of the builder.

LRDD - Static variable in class siren.Relation

Refers to further information about the link's context, expressed as a LRDD ("Link-based Resource Descriptor Document") resource.

M

main(String[]) - Static method in class siren.Program

MEMENTO - Static variable in class siren.Relation

The Target IRI points to a Memento, a fixed resource that will not change state anymore.

method(HttpMethod) - Method in class siren.Action.Builder

Adds the method provided to the current state of the builder.

MONITOR - Static variable in class siren.Relation

Refers to a resource that can be used to monitor changes in an HTTP resource.

MONITOR_GROUP - Static variable in class siren.Relation

Refers to a resource that can be used to monitor changes in a specified group of HTTP resources.

N

name(String) - Method in class siren.Action.Builder

Adds the name provided to the current state of the builder.

name(String) - Method in class siren.Field.Builder

Adds the name provided to the current state of the builder.

NEXT - Static variable in class siren.Relation

Indicates that the link's context is a part of a series, and that the next in the series is the link target.

NEXT_ARCHIVE - Static variable in class siren.Relation

Refers to the immediately following archive resource.

NO_FOLLOW - Static variable in class siren.Relation

Indicates that the context’s original author or publisher does not endorse the link target.

NO_REFERRER - Static variable in class siren.Relation

Indicates that no referrer information is to be leaked when following the link.

O

ORIGINAL - Static variable in class siren.Relation

The Target IRI points to an Original Resource.

P

PAYMENT - Static variable in class siren.Relation

ndicates a resource where payment is accepted.

PINGBACK - Static variable in class siren.Relation

Gives the address of the pingback resource for the link context.

PRECONNECT - Static variable in class siren.Relation

Used to indicate an origin that will be used to fetch required resources for the link context.

PREDECESSOR_VERSION - Static variable in class siren.Relation

Points to a resource containing the predecessor version in the version history.

PREFETCH - Static variable in class siren.Relation

The prefetch link relation type is used to identify a resource that might be required by the next navigation from the link context, and that the user agent ought to fetch, such that the user agent can deliver a faster response once the resource is requested in the future.

PRELOAD - Static variable in class siren.Relation

Refers to a resource that should be loaded early in the processing of the link's context, without blocking rendering.

PRERENDER - Static variable in class siren.Relation

Used to identify a resource that might be required by the next navigation from the link context, and that the user agent ought to fetch and execute, such that the user agent can deliver a faster response once the resource is requested in the future.

PREV - Static variable in class siren.Relation

Indicates that the link's context is a part of a series, and that the previous in the series is the link target.

PREV_ARCHIVE - Static variable in class siren.Relation

Refers to the immediately preceding archive resource.

PREVIEW - Static variable in class siren.Relation

Refers to a resource that provides a preview of the link's context.

PREVIOUS - Static variable in class siren.Relation

Refers to the previous resource in an ordered series of resources.

PRIVACY_POLICY - Static variable in class siren.Relation

Refers to a privacy policy associated with the link's context.

PROFILE - Static variable in class siren.Relation

Identifying that a resource representation conforms to a certain profile, without affecting the non-profile semantics of the resource representation.

Program - Class in siren

Program() - Constructor for class siren.Program

property(String, T) - Method in class siren.EmbeddedRepresentationSubEntity.Builder

Adds the property provided to the current state of the builder.

property(String, T) - Method in class siren.Entity.Builder

Adds the property provided to the current state of the builder.

R

rel(String) - Method in class siren.EmbeddedLinkSubEntity.Builder

Adds the relation provided to the current state of the builder.

rel(URI) - Method in class siren.EmbeddedLinkSubEntity.Builder

Adds the relation provided to the current state of the builder.

rel(Relation) - Method in class siren.EmbeddedLinkSubEntity.Builder

Adds the relation provided to the current state of the builder.

rel(String) - Method in class siren.EmbeddedRepresentationSubEntity.Builder

Adds the relation provided to the current state of the builder.

rel(URI) - Method in class siren.EmbeddedRepresentationSubEntity.Builder

Adds the relation provided to the current state of the builder.

rel(Relation) - Method in class siren.EmbeddedRepresentationSubEntity.Builder

Adds the relation provided to the current state of the builder.

rel(String) - Method in class siren.Link.Builder

Adds the relation provided to the current state of the builder.

rel(URI) - Method in class siren.Link.Builder

Adds the relation provided to the current state of the builder.

rel(Relation) - Method in class siren.Link.Builder

Adds the relation provided to the current state of the builder.

RELATED - Static variable in class siren.Relation

Identifies a related resource.

Relation - Class in siren

Relation(String) - Constructor for class siren.Relation

Constructs an instance of Relation.

Relation(URI) - Constructor for class siren.Relation

Constructs an instance of Relation that is an extension relation.

RelationSerializer - Class in siren.serializers

RelationSerializer() - Constructor for class siren.serializers.RelationSerializer

RelationSerializer(Class<Relation>) - Constructor for class siren.serializers.RelationSerializer

rels(String...) - Method in class siren.EmbeddedLinkSubEntity.Builder

Adds the relations provided to the current state of the builder.

rels(URI...) - Method in class siren.EmbeddedLinkSubEntity.Builder

Adds the relations provided to the current state of the builder.

rels(Relation...) - Method in class siren.EmbeddedLinkSubEntity.Builder

Adds the relations provided to the current state of the builder.

rels(String...) - Method in class siren.EmbeddedRepresentationSubEntity.Builder

Adds the relations provided to the current state of the builder.

rels(URI...) - Method in class siren.EmbeddedRepresentationSubEntity.Builder

Adds the relations provided to the current state of the builder.

rels(Relation...) - Method in class siren.EmbeddedRepresentationSubEntity.Builder

Adds the relations provided to the current state of the builder.

rels(String...) - Method in class siren.Link.Builder

Adds the relations provided to the current state of the builder.

rels(URI...) - Method in class siren.Link.Builder

Adds the relations provided to the current state of the builder.

rels(Relation...) - Method in class siren.Link.Builder

Adds the relations provided to the current state of the builder.

REPLIES - Static variable in class siren.Relation

Identifies a resource that is a reply to the context of the link.

RESTCONF - Static variable in class siren.Relation

Identifies the root of RESTCONF API as configured on this HTTP server.

S

SEARCH - Static variable in class siren.Relation

Refers to a resource that can be used to search through the link's context and related resources.

SECTION - Static variable in class siren.Relation

Refers to a section in a collection of resources.

selected(Boolean) - Method in class siren.FieldValue.Builder

Adds the provided flag indicating whether to be selected to the current state of the builder.

SELF - Static variable in class siren.Relation

Conveys an identifier for the link's context.

serialize(Relation, JsonGenerator, SerializerProvider) - Method in class siren.serializers.RelationSerializer

SERVICE - Static variable in class siren.Relation

Indicates a URI that can be used to retrieve a service document.

siren - package siren

Provides the classes that grant client applications the ability to leverage the power of the siren specification.

siren.factories - package siren.factories

Provides classes that are responsible for the construction of other siren classes.

siren.serializers - package siren.serializers

Provides the classes necessary for proper serialization and deserialization of other siren classes in accordance to the siren specification.

START - Static variable in class siren.Relation

Refers to the first resource in a collection of resources.

STYLESHEET - Static variable in class siren.Relation

Refers to a stylesheet.

subEntities(EntityBase...) - Method in class siren.EmbeddedRepresentationSubEntity.Builder

Adds the sub-entities provided to the current state of the builder.

subEntities(EntityBase...) - Method in class siren.Entity.Builder

Adds the sub-entities provided to the current state of the builder.

subEntity(EntityBase) - Method in class siren.EmbeddedRepresentationSubEntity.Builder

Adds the sub-entity provided to the current state of the builder.

subEntity(EntityBase) - Method in class siren.Entity.Builder

Adds the sub-entity provided to the current state of the builder.

SUBSECTION - Static variable in class siren.Relation

Refers to a resource serving as a subsection in a collection of resources.

SUCCESSOR_VERSION - Static variable in class siren.Relation

Points to a resource containing the successor version in the version history.

T

TAG - Static variable in class siren.Relation

Gives a tag (identified by the given address) that applies to the current document.

TERMS_OF_SERVICE - Static variable in class siren.Relation

Refers to the terms of service associated with the link's context.

TIME_GATE - Static variable in class siren.Relation

The Target IRI points to a TimeGate for an Original Resource.

TIME_MAP - Static variable in class siren.Relation

The Target IRI points to a TimeMap for an Original Resource.

title(String) - Method in class siren.Action.Builder

Adds the title provided to the current state of the builder.

title(String) - Method in class siren.EmbeddedLinkSubEntity.Builder

Adds the title provided to the current state of the builder.

title(String) - Method in class siren.EmbeddedRepresentationSubEntity.Builder

Adds the title provided to the current state of the builder.

title(String) - Method in class siren.Entity.Builder

Adds the title provided to the current state of the builder.

title(String) - Method in class siren.Field.Builder

Adds the title provided to the current state of the builder.

title(String) - Method in class siren.FieldValue.Builder

Adds the title provided to the current state of the builder.

title(String) - Method in class siren.Link.Builder

Sets current state of the builder to have the title provided.

toString() - Method in enum siren.FieldType

Retrieves a textual representation of the field type.

toString() - Method in enum siren.HttpMethod

Retrieves a textual representation of the HTTP method.

toString() - Method in class siren.Relation

Retrieves a textual representation of the relation.

type(String) - Method in class siren.Action.Builder

Adds the type provided to the current state of the builder.

type(String) - Method in class siren.EmbeddedLinkSubEntity.Builder

Adds the type provided to the current state of the builder.

type(FieldType) - Method in class siren.Field.Builder

Adds the type provided to the current state of the builder.

type(String) - Method in class siren.Link.Builder

Sets the current state of the builder to have the type provided.

TYPE - Static variable in class siren.Relation

Refers to a resource identifying the abstract semantic type of which the link's context is considered to be an instance.

U

UP - Static variable in class siren.Relation

Refers to a parent document in a hierarchy of documents.

V

value(T) - Method in class siren.Field.Builder

Adds the value provided to the current state of the builder.

value(T) - Method in class siren.FieldValue.Builder

Adds the value provided to the current state of the builder.

valueOf(String) - Static method in enum siren.FieldType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum siren.HttpMethod

Returns the enum constant of this type with the specified name.

values() - Static method in enum siren.FieldType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum siren.HttpMethod

Returns an array containing the constants of this enum type, in the order they are declared.

VERSION_HISTORY - Static variable in class siren.Relation

Points to a resource containing the version history for the context.

VIA - Static variable in class siren.Relation

Identifies a resource that is the source of the information in the link's context.

W

WEB_MENTION - Static variable in class siren.Relation

Identifies a target URI that supports the Webmention protcol.

WORKING_COPY - Static variable in class siren.Relation

Points to a working copy for this resource.

WORKING_COPY_OF - Static variable in class siren.Relation

Points to the versioned resource from which this working copy was obtained.

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