Package ch.tocco.nice2.rest.core.spi.beans

Class HalBean

java.lang.Object

ch.tocco.nice2.rest.core.spi.beans.HalBean

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AbstractAutoCompleteResource.AutoCompleteValues, ActionResponseBean, BreadcrumbsBean, BulkDeletionStatusBean, CheckUsernameBean, DashboardBean, DisplayBean, DisplayExpressionCollectionBean, EntityBean, EntityModelBean, EntityModelsBean, EvaluationBean, FormBean, FreemarkerConfigBean, GreenMailBean, InitialValueGeneratorResource.InitialValueResponseBean, InputBean, LoadedPropertiesBean, LocalesBean, LocalesBestBean, MarkedBean, MarkingsBean, MenuBean, MergeBean, MergeSourceDataBean, MessageBean, MetaDataBean, ModulesBean, MultiCountBean, MultiStatusBean, OpenIdClaimsBean, ParticipantBean, PasswordRulesBean, PreferencesBean, PrincipalInfoBean, ReportGenerationBean, ReportSettingsBean, RootBean, SearchFiltersBean, SettingsBean, StructureBean, TwoFactorActivateBean, TwoFactorBean, UpdatePasswordBean, ValidationResultBean, WidgetConfigBean

public class HalBean
extends Object
implements Serializable

Base class for HAL representations.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
HalBean()

Method Summary

Modifier and Type	Method	Description
HalBean	addLink(String rel, HalLink link)
HalBean	addLinks(Map<String,HalLink> links)
@Nullable HashMap<String,HalLink>	get_links()	The links of the bean.
void	set_links(LinkedHashMap<String,HalLink> links)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

HalBean

public HalBean()

Method Details

get_links

@Nullable
public @Nullable HashMap<String,HalLink> get_links()

The links of the bean. Caution: Always returns `null` if RequestContext.linksOmitted() is `true`, as we don't want the links to occur in the response in this case.

Returns:

the links or `null`, if RequestContext.linksOmitted() is `true`

set_links

public void set_links(LinkedHashMap<String,HalLink> links)

addLink

public HalBean addLink(String rel,
 HalLink link)

addLinks

public HalBean addLinks(Map<String,HalLink> links)