org.apache.juneau.rest.RestChild Maven / Gradle / Ivy
// ***************************************************************************************************************************
// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file *
// * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file *
// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance *
// * with the License. You may obtain a copy of the License at *
// * *
// * http://www.apache.org/licenses/LICENSE-2.0 *
// * *
// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an *
// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *
// * specific language governing permissions and limitations under the License. *
// ***************************************************************************************************************************
package org.apache.juneau.rest;
/**
* Represents a simple child REST resource / path mapping.
*
* Example:
*
* // Parent resource.
* public class MyResource {
* public MyResource(RestContextBuilder builder) throws Exception {
*
* // Register a child resource.
* builder.children(new RestChild("/child" , new MyChildResource());
*
* // The above is equivalent to...
* builder.child("/child" , new MyChildResource());
* }
* }
*
*
* See Also:
*
* - {@doc juneau-rest-server.Instantiation.Children}
*
*/
public class RestChild {
final String path;
final Object resource;
/**
* Constructor.
*
* @param path The child resource path relative to the parent resource URI.
* @param resource
* The child resource.
*
Can either be a Class (which will be instantiated using the registered {@link RestResourceResolver})
* or an already-instantiated object.
*/
public RestChild(String path, Object resource) {
this.path = path;
this.resource = resource;
}
}