org.apache.juneau.rest.converters

Class Traversable

java.lang.Object

org.apache.juneau.rest.converters.Traversable

All Implemented Interfaces:

RestConverter

public final class Traversable
extends Object
implements RestConverter

Converter for enabling of PojoRest support on response objects returned by a @RestMethod method.

When enabled, objects in a POJO tree returned by the REST method can be addressed through additional URL path information.

// Resource method on resource "http://localhost:8080/sample/addressBook" @RestMethod(name=GET, converters=Traversable.class) public void doGet(RestRequest req, RestResponse res) { return new AddressBook(); } // Sample usage public static void main(String[] args) { // Get the zip code of the 2nd address of the first person in the address book. RestCall r = new RestClient().doGet("http://localhost:8080/sample/addressBook/0/addresses/1/zip"); int zip = r.getResponse(Integer.class); }

See Also:

• PojoRest - Additional information on addressing elements in a POJO tree using URL notation.
• RestContext.REST_converters - Registering converters with REST resources.
• Overview > juneau-rest-server > Converters

Constructor Summary

Constructors

Constructor and Description
Traversable()

Method Summary

Modifier and Type	Method and Description
Object	convert(RestRequest req, Object o) Performs post-call conversion on the specified response object.

Methods inherited from class java.lang.Object

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

Constructor Detail

Traversable

public Traversable()

Method Detail

convert

public Object convert(RestRequest req,
                      Object o)
               throws RestException

Description copied from interface: RestConverter

Performs post-call conversion on the specified response object.

Specified by:

convert in interface RestConverter

Parameters:

req - The servlet request.

o - The response object set by the REST method through the RestResponse.setOutput(Object) method.

Returns:

The converted object.

Throws:

RestException - Thrown if any errors occur during conversion.