io.neba.api.annotations.Path 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 io.neba.api.spi.PlaceholderVariableResolver;

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


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

/**
 * 

 * Defines the relative or absolute path of a property or resource mapped to a
 * field. Can be used when the name of the field does not match the name of
 * the mapped child resource or property, e.g. in case namespaces are used, or
 * if an absolute or relative path is to be mapped. 
 Supports placeholders of the form
 * ${name}, which are resolved by {@link PlaceholderVariableResolver} service.
 *
 *
 * Example
 *
 *  * public class Model {
 *     @Path("jcr:title")
 *     private String title;
 *     @Path("/content/homepage")
 *     private Page homepage;
 *     @Path("../toolbar")
 *     private Page toolbar;
 *     @Path("/content/${market}/${language}")
 *     private Page toolbar;
 * }
 * 
 *
 * @since 1.0.0
 * @author Olaf Otto
 */
@Documented
@Target({FIELD, ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface Path {
    String value();
}