io.muserver.rest

Class SchemaObjectCustomizerContext

java.lang.Object

io.muserver.rest.SchemaObjectCustomizerContext

public class SchemaObjectCustomizerContext
extends Object

Provides the context that a SchemaObject is in when customizing the schema in a SchemaObjectCustomizer

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.MediaType	mediaType()
Optional<Method>	methodHandle()
Optional<Type>	parameterizedType()
Optional<String>	parameterName()
Object	resource() For normal resources, this is the instance passed to the RestHandlerBuilder.
SchemaObjectCustomizerTarget	target()
String	toString()
Class<?>	type()

Methods inherited from class java.lang.Object

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

Method Detail

target

public SchemaObjectCustomizerTarget target()

Returns:

The type of object being described, e.g. a request body or response body.

resource

public Object resource()

For normal resources, this is the instance passed to the RestHandlerBuilder. Note that for sub-resources returned by a sub-resource-locator, this will be null.

Returns:

The rest resource that creates or consumes the object being described

methodHandle

public Optional<Method> methodHandle()

Returns:

The java method that builds or consumes the object being described

parameterName

public Optional<String> parameterName()

Returns:

Where target() is SchemaObjectCustomizerTarget.FORM_PARAM, this returns the form parameter name.

type

public Class<?> type()

Returns:

The java type of the object being described

parameterizedType

public Optional<Type> parameterizedType()

Returns:

For generic types, this is the generic type parameter

mediaType

public javax.ws.rs.core.MediaType mediaType()

Returns:

The media type of the schema being described

toString

public String toString()

Overrides:

toString in class Object