Package org.apache.juneau.rest.server.arg

Class RecordWriterArg

java.lang.Object

org.apache.juneau.rest.server.arg.SimpleRestOperationArg

org.apache.juneau.rest.server.arg.RecordWriterArg

All Implemented Interfaces:

RestOpArg

public class RecordWriterArg
extends SimpleRestOperationArg

Resolves method parameters of type RecordWriter (or any subtype) on RestOp-annotated Java methods.

The parameter value is resolved by:

1. Negotiating the response's Accept to a matched Serializer.
2. Building a request-configured SerializerSession and calling writeRecords(output) on it.
3. Verifying the returned cursor is assignable to the declared parameter type.

Declaring this parameter flips the response into "user owns the body" mode — the framework will not later serialize a POJO return value over the same stream. Same contract as declaring an OutputStream or Writer parameter today.

Rejection paths (all surfaced as HTTP 415 / 406):

• No serializer matched the Accept — resolution returns null and the framework rejects the request (415/406 via the empty match).
• Matched serializer does not implement RecordWritable — throws UnsupportedMediaType (415).
• Matched serializer produces a cursor not assignable to the declared parameter type — throws UnsupportedMediaType (415).

See Also:

• Java Method Parameters

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RecordWriterArg(Class<?> declaredType)	Constructor.

Method Summary

Modifier and Type	Method	Description
static RecordWriterArg	create(ParameterInfo paramInfo)	Static creator.
Class<?>	getDeclaredType()	Returns the declared parameter type.

Methods inherited from class org.apache.juneau.rest.server.arg.SimpleRestOperationArg

resolve

Methods inherited from class java.lang.Object

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

Constructor Details

RecordWriterArg

protected RecordWriterArg(Class<?> declaredType)

Constructor.

Method Details

create

public static RecordWriterArg create(ParameterInfo paramInfo)

Static creator.

Parameters:

paramInfo - The Java method parameter being resolved. Must not be null.

Returns:

A new RecordWriterArg, or null if the parameter type is not RecordWriter or a subtype (other than TokenWriter — that case is handled by TokenWriterArg).

getDeclaredType

public Class<?> getDeclaredType()

Returns the declared parameter type.