View Javadoc

1   /*
2    * Copyright (C) 2013 AMIS research group, Faculty of Mathematics and Physics, Charles University in Prague, Czech Republic
3    *
4    * This program is free software: you can redistribute it and/or modify
5    * it under the terms of the GNU General Public License as published by
6    * the Free Software Foundation, either version 3 of the License, or
7    * (at your option) any later version.
8    *
9    * This program is distributed in the hope that it will be useful,
10   * but WITHOUT ANY WARRANTY; without even the implied warranty of
11   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12   * GNU General Public License for more details.
13   *
14   * You should have received a copy of the GNU General Public License
15   * along with this program.  If not, see <http://www.gnu.org/licenses/>.
16   */
17  package cz.cuni.amis.pogamut.unreal.t3dgenerator.annotations;
18  
19  import java.lang.annotation.ElementType;
20  import java.lang.annotation.Retention;
21  import java.lang.annotation.RetentionPolicy;
22  import java.lang.annotation.Target;
23  
24  /**
25   * Interface to mark enums as representable in UT3.
26   * Unless {@link EnumValue} is specified for enum fields, their name is converted from
27   * Java enum constant form (OVERWRITE_ALL) to T3D format (OverwriteAll). This annotation's
28   * value is prepended to the field name, enluess {@link EnumValue#raw() } is set.
29   * @author Martin Cerny
30   */
31  @Retention(RetentionPolicy.RUNTIME)
32  @Target({ElementType.TYPE})    
33  public @interface UnrealEnum {
34      /**
35       * The prefix used for enum expression. Prepended to strings for all enum values
36       * @return 
37       */
38      String value();
39  }