com.helger.commons.annotation.CodingStyleguideUnaware Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ph-commons Show documentation

Java 1.6+ Library with tons of utility classes required in all projects

There is a newer version: 9.5.5

/**
 * Copyright (C) 2014-2016 Philip Helger (www.helger.com)
 * philip[at]helger[dot]com
 *
 * 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 com.helger.commons.annotation;

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

/**
 * This is an indicator, that an object is aware to break the style guide. This
 * may be evaluated in coding style guide checks.
 *
 * @author Philip Helger
 */
@Retention (RetentionPolicy.CLASS)
@Target ({ ElementType.TYPE,
           ElementType.FIELD,
           ElementType.METHOD,
           ElementType.PARAMETER,
           ElementType.CONSTRUCTOR,
           ElementType.LOCAL_VARIABLE,
           ElementType.ANNOTATION_TYPE,
           ElementType.PACKAGE })
@Documented
public @interface CodingStyleguideUnaware
{
  /**
   * @return Optional comment why this element is coding styleguide unaware.
   */
  String value() default "";

  /**
   * @return Optional code identifying the reason why this element is coding
   *         styleguide unaware. The interpretation of this code is usage
   *         dependent.
   */
  String code() default "";
}