org.springframework.restdocs.snippet

Class AbstractDescriptor<T extends AbstractDescriptor<T>>

java.lang.Object

org.springframework.restdocs.snippet.AbstractDescriptor<T>

Type Parameters:

T - the type of the descriptor

Direct Known Subclasses:

FieldDescriptor, LinkDescriptor, ParameterDescriptor

public abstract class AbstractDescriptor<T extends AbstractDescriptor<T>>
extends Object

Base class for descriptors. Provides the ability to associate arbitrary attributes with a descriptor.

Author:

Andy Wilkinson

Constructor Summary

Constructors

Constructor and Description
AbstractDescriptor()

Method Summary

Modifier and Type	Method and Description
T	attributes(Attributes.Attribute... attributes) Adds the given attributes to the descriptor
Map<String,Object>	getAttributes() Returns the descriptor's attributes

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractDescriptor

public AbstractDescriptor()

Method Detail

attributes

public T attributes(Attributes.Attribute... attributes)

Adds the given attributes to the descriptor

Parameters:

attributes - the attributes

Returns:

the descriptor

getAttributes

public final Map<String,Object> getAttributes()

Returns the descriptor's attributes

Returns:

the attributes