org.osgi.service.metatype.annotations.ObjectClassDefinition Maven / Gradle / Ivy

/*
 * Copyright (c) OSGi Alliance (2013, 2014). All Rights Reserved.
 *
 * 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 org.osgi.service.metatype.annotations;

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

/**
 * Generate a Meta Type Resource using the annotated type as an
 * {@code ObjectClassDefinition}.
 * 
 * 
 * This annotation can be used without defining any element values as defaults
 * can be generated from the annotated type. Each method of the annotated type
 * has an implied {@link AttributeDefinition} annotation if not explicitly
 * annotated.
 * 
 * 

 * This annotation is not processed at runtime. It must be processed by tools
 * and used to generate a Meta Type Resource document for the bundle.
 * 
 * @see "The OCD element of a Meta Type Resource."
 * @author $Id: 1f2e2b936147451fe0a3d424fb6c5bb5525b48c2 $
 */
@Retention(RetentionPolicy.CLASS)
@Target(ElementType.TYPE)
public @interface ObjectClassDefinition {
	/**
	 * The id of this ObjectClassDefinition.
	 * 
	 * 

	 * If not specified, the id of this ObjectClassDefinition is the fully
	 * qualified name of the annotated type using the dollar sign ({@code '$'}
	 * \u0024) to separate nested class names from the name of their
	 * enclosing class. The id is not to be confused with a PID which can be
	 * specified by the {@link #pid()} or {@link #factoryPid()} element.
	 * 
	 * @see "The id attribute of the OCD element of a Meta Type Resource."
	 */
	String id() default "";

	/**
	 * The human readable name of this ObjectClassDefinition.
	 * 
	 * 

	 * If not specified, the name of this ObjectClassDefinition is derived from
	 * the {@link #id()}. For example, low line ({@code '_'} \u005F) and
	 * dollar sign ({@code '$'} \u0024) are replaced with space ({@code ' '}
	 * \u0020) and space is inserted between camel case words.
	 * 
	 * 

	 * If the name begins with the percent sign ({@code '%'} \u0025), the
	 * name can be {@link #localization() localized}.
	 * 
	 * @see "The name attribute of the OCD element of a Meta Type Resource."
	 */
	String name() default "";

	/**
	 * The human readable description of this ObjectClassDefinition.
	 * 
	 * 

	 * If not specified, the description of this ObjectClassDefinition is the
	 * empty string.
	 * 
	 * 

	 * If the description begins with the percent sign ({@code '%'} \u0025),
	 * the description can be {@link #localization() localized}.
	 * 
	 * @see "The description attribute of the OCD element of a Meta Type Resource."
	 */
	String description() default "";

	/**
	 * The localization resource of this ObjectClassDefinition.
	 * 
	 * 

	 * This refers to a resource property entry in the bundle that can be
	 * augmented with locale information. If not specified, the localization
	 * resource of this ObjectClassDefinition is the string
	 * "OSGI-INF/l10n/" followed by the fully qualified name of the
	 * annotated type.
	 * 
	 * @see "The localization attribute of the OCD element of a Meta Type Resource."
	 */
	String localization() default "";

	/**
	 * The PIDs associated with this ObjectClassDefinition.
	 * 
	 * 

	 * For each specified PID, a {@code Designate} element with a pid attribute
	 * is generated that {@link #id() references} this ObjectClassDefinition. If
	 * not specified, no Designate elements with pid attributes will be
	 * generated.
	 * 
	 * @see "The pid of the Designate element of a Meta Type Resource."
	 */
	String[] pid() default {};

	/**
	 * The factory PIDs associated with this ObjectClassDefinition.
	 * 
	 * 

	 * For each specified factory PID, a {@code Designate} element with a
	 * factoryPid attribute is generated that {@link #id() references} this
	 * ObjectClassDefinition. If not specified, no Designate elements with
	 * factoryPid attributes will be generated.
	 * 
	 * @see "The factoryPid of the Designate element of a Meta Type Resource."
	 */
	String[] factoryPid() default {};

	/**
	 * The icon resources associated with this ObjectClassDefinition.
	 * 
	 * 
	 * For each specified {@link Icon}, an {@code Icon} element is generated for
	 * this ObjectClassDefinition. If not specified, no Icon elements will be
	 * generated.
	 * 
	 * @see "The Icon element of a Meta Type Resource."
	 */
	Icon[] icon() default {};
}