Package com.broadleafcommerce.metadata.dsl.core.extension.endpoints

Class AbstractEndpoint<E extends AbstractEndpoint<E>>

java.lang.Object

com.broadleafcommerce.metadata.dsl.core.extension.endpoints.AbstractEndpoint<E>

All Implemented Interfaces:

Copyable<E>, Endpoint<E>, Serializable

Direct Known Subclasses:

DefaultEndpoint, DefaultPageableEndpoint

public abstract class AbstractEndpoint<E extends AbstractEndpoint<E>>
extends Object
implements Endpoint<E>

Author:

Nick Crum (ncrum)

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.broadleafcommerce.metadata.dsl.core.Endpoint

Endpoint.Attributes, Endpoint.Method

Constructor Summary

Constructors

Constructor	Description
AbstractEndpoint()
AbstractEndpoint(Endpoint<?> endpoint)

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Map<String,Object>	getAttributes()	A key-value map used to provide additional metadata beyond the first-class properties.
List<Conditional<?>>	getConditionals()	A set of conditions used to indicate when this component should be rendered.
Map<String,Object>	getHeaders()
List<Mapping<?>>	getMapParams()
Endpoint.Method	getMethod()
Map<String,String>	getParams()
Component<?>	getParent()
String	getScope()
TransformBody	getTransformRequestBody()
TransformBody	getTransformResponseBody()
String	getType()
String	getUri()
int	hashCode()
void	setAttributes(Map<String,Object> attributes)	Sets the attributes map.
void	setConditionals(List<Conditional<?>> conditionals)	Sets the conditionals for this component.
void	setHeaders(Map<String,Object> headers)
void	setMapParams(List<Mapping<?>> mapParams)
void	setMethod(Endpoint.Method method)
void	setParams(Map<String,String> params)
void	setParent(Component<?> parent)
void	setScope(String scope)
void	setTransformRequestBody(TransformBody transformRequestBody)
void	setTransformResponseBody(TransformBody transformResponseBody)
void	setType(String type)
void	setUri(String uri)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.Copyable

copy

Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.Endpoint

apply, attribute, clearConditionals, clearHeaders, clearParamMappings, clearParams, conditional, conditionals, delete, findAttribute, findAttribute, get, getAttribute, getAttribute, hasAttribute, header, headers, mapParam, mapParams, method, method, param, params, patch, post, put, removeAttribute, removeHeader, removeMapParam, removeParam, responseIsPartialState, responseIsPartialState, scope, scopes, self, transformRequest, transformRequest, transformResponse, transformResponse, type, uri

Constructor Details

AbstractEndpoint

public AbstractEndpoint()

AbstractEndpoint

public AbstractEndpoint(Endpoint<?> endpoint)

Method Details

getAttributes

public Map<String,Object> getAttributes()

Description copied from interface: Endpoint

A key-value map used to provide additional metadata beyond the first-class properties. By default, this method returns a read-only empty map for backwards compatibility. Either extend AbstractEndpoint or ensure that your implementation overrides this default method.

Specified by:

getAttributes in interface Endpoint<E extends AbstractEndpoint<E>>

Returns:

the attributes map

setAttributes

public void setAttributes(Map<String,Object> attributes)

Description copied from interface: Endpoint

Sets the attributes map. This is a no-op for backwards compatibility. Either extend AbstractEndpoint or ensure that your implementation overrides this default method.

Specified by:

setAttributes in interface Endpoint<E extends AbstractEndpoint<E>>

Parameters:

attributes - the attributes map

getType

public String getType()

Specified by:

getType in interface Endpoint<E extends AbstractEndpoint<E>>

getUri

public String getUri()

Specified by:

getUri in interface Endpoint<E extends AbstractEndpoint<E>>

getMethod

public Endpoint.Method getMethod()

Specified by:

getMethod in interface Endpoint<E extends AbstractEndpoint<E>>

getScope

public String getScope()

Specified by:

getScope in interface Endpoint<E extends AbstractEndpoint<E>>

getParams

public Map<String,String> getParams()

Specified by:

getParams in interface Endpoint<E extends AbstractEndpoint<E>>

getHeaders

public Map<String,Object> getHeaders()

Specified by:

getHeaders in interface Endpoint<E extends AbstractEndpoint<E>>

getMapParams

public List<Mapping<?>> getMapParams()

Specified by:

getMapParams in interface Endpoint<E extends AbstractEndpoint<E>>

getTransformRequestBody

public TransformBody getTransformRequestBody()

Specified by:

getTransformRequestBody in interface Endpoint<E extends AbstractEndpoint<E>>

getTransformResponseBody

public TransformBody getTransformResponseBody()

Specified by:

getTransformResponseBody in interface Endpoint<E extends AbstractEndpoint<E>>

getConditionals

public List<Conditional<?>> getConditionals()

Description copied from interface: Endpoint

A set of conditions used to indicate when this component should be rendered. This is most commonly used by form components to hide/show fields and grids depending on the form state.

Specified by:

getConditionals in interface Endpoint<E extends AbstractEndpoint<E>>

Returns:

the set of conditionals

getParent

public Component<?> getParent()

Specified by:

getParent in interface Endpoint<E extends AbstractEndpoint<E>>

setType

public void setType(String type)

Specified by:

setType in interface Endpoint<E extends AbstractEndpoint<E>>

setUri

public void setUri(String uri)

Specified by:

setUri in interface Endpoint<E extends AbstractEndpoint<E>>

setMethod

public void setMethod(Endpoint.Method method)

Specified by:

setMethod in interface Endpoint<E extends AbstractEndpoint<E>>

setScope

public void setScope(String scope)

Specified by:

setScope in interface Endpoint<E extends AbstractEndpoint<E>>

setParams

public void setParams(Map<String,String> params)

Specified by:

setParams in interface Endpoint<E extends AbstractEndpoint<E>>

setHeaders

public void setHeaders(Map<String,Object> headers)

Specified by:

setHeaders in interface Endpoint<E extends AbstractEndpoint<E>>

setMapParams

public void setMapParams(List<Mapping<?>> mapParams)

Specified by:

setMapParams in interface Endpoint<E extends AbstractEndpoint<E>>

setTransformRequestBody

public void setTransformRequestBody(TransformBody transformRequestBody)

Specified by:

setTransformRequestBody in interface Endpoint<E extends AbstractEndpoint<E>>

setTransformResponseBody

public void setTransformResponseBody(TransformBody transformResponseBody)

Specified by:

setTransformResponseBody in interface Endpoint<E extends AbstractEndpoint<E>>

setConditionals

public void setConditionals(List<Conditional<?>> conditionals)

Description copied from interface: Endpoint

Sets the conditionals for this component.

Specified by:

setConditionals in interface Endpoint<E extends AbstractEndpoint<E>>

Parameters:

conditionals - the conditionals

setParent

public void setParent(Component<?> parent)

Specified by:

setParent in interface Endpoint<E extends AbstractEndpoint<E>>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object