Package com.kazforge.jsonapi.representation

Class RepresentationSelection.Builder

java.lang.Object

com.kazforge.jsonapi.representation.RepresentationSelection.Builder

Enclosing class:

RepresentationSelection

public static final class RepresentationSelection.Builder
extends Object

Mutable builder whose build() result defensively copies all supplied values.

Method Summary

Modifier and Type	Method	Description
RepresentationSelection	build()	Builds an immutable representation selection.
RepresentationSelection.Builder	fields(String resourceType, String... fieldNames)	Selects fields for one resource type.
RepresentationSelection.Builder	fields(String resourceType, List<String> fieldNames)	Selects fields for one resource type.
RepresentationSelection.Builder	include(IncludePath path)	Adds one already-validated include path.
RepresentationSelection.Builder	include(String path)	Parses and adds one dotted include path using IncludePath's validation.
RepresentationSelection.Builder	includeRequested()	Records an explicit include request without adding an include path.

Methods inherited from class java.lang.Object

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

Method Details

include

public RepresentationSelection.Builder include(String path)

Parses and adds one dotted include path using IncludePath's validation.

include

public RepresentationSelection.Builder include(IncludePath path)

Adds one already-validated include path.

includeRequested

public RepresentationSelection.Builder includeRequested()

Records an explicit include request without adding an include path.

fields

public RepresentationSelection.Builder fields(String resourceType,
 String... fieldNames)

Selects fields for one resource type. Repeated names retain their first-seen order.

fields

public RepresentationSelection.Builder fields(String resourceType,
 List<String> fieldNames)

Selects fields for one resource type. Repeated names retain their first-seen order.

build

public RepresentationSelection build()

Builds an immutable representation selection.