1 /*
2 * ModeShape (http://www.modeshape.org)
3 * See the COPYRIGHT.txt file distributed with this work for information
4 * regarding copyright ownership. Some portions may be licensed
5 * to Red Hat, Inc. under one or more contributor license agreements.
6 * See the AUTHORS.txt file in the distribution for a full listing of
7 * individual contributors.
8 *
9 * ModeShape is free software. Unless otherwise indicated, all code in ModeShape
10 * is licensed to you under the terms of the GNU Lesser General Public License as
11 * published by the Free Software Foundation; either version 2.1 of
12 * the License, or (at your option) any later version.
13 *
14 * ModeShape is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
18 *
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with this software; if not, write to the Free
21 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
22 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
23 */
24 package org.modeshape.common.annotation;
25
26 import static java.lang.annotation.ElementType.CONSTRUCTOR;
27 import static java.lang.annotation.ElementType.FIELD;
28 import static java.lang.annotation.ElementType.METHOD;
29 import static java.lang.annotation.ElementType.PACKAGE;
30 import static java.lang.annotation.ElementType.TYPE;
31 import static java.lang.annotation.RetentionPolicy.RUNTIME;
32 import java.lang.annotation.Documented;
33 import java.lang.annotation.Retention;
34 import java.lang.annotation.Target;
35 import org.modeshape.common.i18n.I18n;
36
37 /**
38 * Annotation that can be used provide a human-readable category.
39 */
40 @Documented
41 @Retention( RUNTIME )
42 @Target( {FIELD, METHOD, CONSTRUCTOR, PACKAGE, TYPE} )
43 public @interface Category {
44 /**
45 * The label for the element. This value can either be the literal label, or it can be the {@link I18n#id() identifier} of an
46 * {@link I18n} instance on the non-null {@link #i18n()} I18n container class.
47 *
48 * @return the issue
49 */
50 String value();
51
52 /**
53 * The class that contains the {@link I18n} instances used for internationalization. This may be null if the description is a
54 * literal value.
55 *
56 * @return the class that contains the I18n instance identified by the {@link #value()}
57 */
58 Class<?> i18n();
59 }