org.springframework.restdocs.snippet

Class Attributes

java.lang.Object

org.springframework.restdocs.snippet.Attributes

public abstract class Attributes
extends java.lang.Object

A fluent API for building a map of attributes.

Author:

Andy Wilkinson

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Attributes.Attribute An attribute (key-value pair).
static class	Attributes.AttributeBuilder A simple builder for an attribute (key-value pair).

Method Summary

Modifier and Type	Method and Description
static java.util.Map<java.lang.String,java.lang.Object>	attributes(Attributes.Attribute... attributes) Creates a Map of the given attributes.
static Attributes.AttributeBuilder	key(java.lang.String key) Creates an attribute with the given key.

Methods inherited from class java.lang.Object

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

Method Detail

key

public static Attributes.AttributeBuilder key(java.lang.String key)

Creates an attribute with the given key. A value for the attribute must still be specified.

Parameters:

key - The key of the attribute

Returns:

An AttributeBuilder to use to specify the value of the attribute

See Also:

Attributes.AttributeBuilder.value(Object)

attributes

public static java.util.Map<java.lang.String,java.lang.Object> attributes(Attributes.Attribute... attributes)

Creates a Map of the given attributes.

Parameters:

attributes - The attributes

Returns:

A Map of the attributes