io.neba.api.annotations.Children Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of io.neba.neba-api Show documentation

Contains all annotations, tag libraries and lifecycle callback interfaces of NEBA. All packages of this API bundle are exported. Change to the API that are not byte code compatible only occur in major revisions.

There is a newer version: 5.2.3

Show newest version

/**
 * Copyright 2013 the original author or authors.
 * 
 * Licensed 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 io.neba.api.annotations;

import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import static java.lang.annotation.ElementType.ANNOTATION_TYPE;
import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
 * 
 * Provides a {@link java.util.Collection}, {@link java.util.List} or {@link java.util.Set}
 * of children of the resource. The resource might be the current resource itself,
 * a resource designated by a {@link io.neba.api.annotations.Path} annotation
 * or a {@link io.neba.api.annotations.Reference referenced} resource.
 * 
 *
 * 
*     Examples
 * 
 *
 * Children of the current resource
 *  * @{@link Children}
 * private List<Resource> children;
 * 
 *
 * Children of the current resource as Pages
 *  * @{@link Children}
 * private List<Page> pages;
 * 
 *
 * Children of the resource at the path "/path/to/resource"
 *  * @{@link Path}("/path/to/resource")
 * @{@link Children}
 * private List<Page> pages;
 * 
 *
 * Children of the resource referenced in the property named "pages"
 *  * @{@link Reference}
 * @{@link Children}
 * private List<Page> pages;
 * 
 *
 * Children of the resource referenced in the property named "propContainingReference"
 *  * @{@link Path}("propContainingReference")
 * @{@link Reference}
 * @{@link Children}
 * private List<Page> pages;
 * 
 *
 * The "jcr:content" node of Children of the current resource,
 * adapted to "PageContent".
 *  * @{@link Children}(resolveBelowEveryChild = "/jcr:content")
 * private List<PageContent> pageContents;
 * 
 *
 * @author Olaf Otto
 * @author Daniel Rey
 */
@Documented
@Target({FIELD, ANNOTATION_TYPE})
@Retention(RUNTIME)
public @interface Children {
    /**
     * @return the relative path to use to resolve a resource below each child instead
     * of using the child directly.
     */
    String resolveBelowEveryChild() default "";
}