001/**
002 * #-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=#
003 *   This file is part of the LDP4j Project:
004 *     http://www.ldp4j.org/
005 *
006 *   Center for Open Middleware
007 *     http://www.centeropenmiddleware.com/
008 * #-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=#
009 *   Copyright (C) 2014 Center for Open Middleware.
010 * #-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=#
011 *   Licensed under the Apache License, Version 2.0 (the "License");
012 *   you may not use this file except in compliance with the License.
013 *   You may obtain a copy of the License at
014 *
015 *             http://www.apache.org/licenses/LICENSE-2.0
016 *
017 *   Unless required by applicable law or agreed to in writing, software
018 *   distributed under the License is distributed on an "AS IS" BASIS,
019 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
020 *   See the License for the specific language governing permissions and
021 *   limitations under the License.
022 * #-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=#
023 *   Artifact    : org.ldp4j.framework:ldp4j-application-api:0.2.0
024 *   Bundle      : ldp4j-application-api-0.2.0.jar
025 * #-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=#
026 */
027package org.ldp4j.application.ext.annotations;
028
029import java.lang.annotation.Documented;
030import java.lang.annotation.ElementType;
031import java.lang.annotation.Retention;
032import java.lang.annotation.RetentionPolicy;
033import java.lang.annotation.Target;
034
035import org.ldp4j.application.ext.ResourceHandler;
036
037/**
038 * Used for defining LDP resources that are attached to other LDP resources.
039 */
040@Documented
041@Retention(RetentionPolicy.RUNTIME)
042@Target({ElementType.ANNOTATION_TYPE})
043public @interface Attachment {
044
045  /**
046   * The identifier of the attachment. The identifier must be
047   * template-unique.
048   */
049  String id();
050
051  /** The human-based name of the attachment. */
052  String name() default "";
053
054  /** A description of the purpose of the attachment. */
055  String description() default "";
056
057  /** The relative path to be used when publishing the attached resource. */
058  String path();
059
060  /**
061   * If defined, the predicate to be used for relating the attaching resource
062   * to the attached resource
063   */
064  String predicate() default "";
065
066  /**
067   * The {@code ResourceHandler} class that will handle the attached resource.
068   */
069  Class<? extends ResourceHandler> handler();
070
071}