Package org.apache.juneau.rest.client.remote

Class RemoteOperationArg

java.lang.Object

org.apache.juneau.rest.client.remote.RemoteOperationArg

public class RemoteOperationArg
extends Object

Represents the metadata about an annotated argument of a method on a REST proxy class.

See Also:

• REST Proxy Basics
• juneau-rest-client Basics

Method Summary

Modifier and Type	Method	Description
int	getIndex()	Returns the method argument index.
String	getName()	Returns the name of the HTTP part.
HttpPartType	getPartType()	Returns the HTTP part type.
HttpPartSchema	getSchema()	Returns the HTTP part schema information about this part.
Optional<HttpPartSerializer>	getSerializer()	Returns the HTTP part serializer to use for serializing this part.
boolean	isSkipIfEmpty()	Returns whether the skipIfEmpty flag was found in the schema.

Methods inherited from class java.lang.Object

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

Method Details

getName

public String getName()

Returns the name of the HTTP part.

Returns:

The name of the HTTP part.

isSkipIfEmpty

public boolean isSkipIfEmpty()

Returns whether the skipIfEmpty flag was found in the schema.

Returns:

true if the skipIfEmpty flag was found in the schema.

getIndex

public int getIndex()

Returns the method argument index.

Returns:

The method argument index.

getPartType

public HttpPartType getPartType()

Returns the HTTP part type.

Returns:

The HTTP part type. Never null.

getSerializer

public Optional<HttpPartSerializer> getSerializer()

Returns the HTTP part serializer to use for serializing this part.

Returns:

The HTTP part serializer, or the default if not specified.

getSchema

public HttpPartSchema getSchema()

Returns the HTTP part schema information about this part.

Returns:

The HTTP part schema information, or null if not found.