com.igormaznitsa.mindmap.annotations.MmdFileRef Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mind-map-annotations Show documentation
Set of annotations to mark sources to generate MMD maps
The newest version!
/*
 * Copyright (C) 2015-2022 Igor A. Maznitsa
 *
 * 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.igormaznitsa.mindmap.annotations;

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

/**
 * Annotation allows to make a reference to a some marked {@link MmdFile}
 * or {@link MmdFiles} class through MMD file UID or a class object.
 *
 * @see MmdFile
 * @see MmdFiles
 */
@Retention(RetentionPolicy.SOURCE)
@Target({
    ElementType.TYPE,
    ElementType.FIELD,
    ElementType.METHOD,
    ElementType.CONSTRUCTOR,
    ElementType.ANNOTATION_TYPE,
    ElementType.PACKAGE,
    ElementType.TYPE_PARAMETER,
    ElementType.PARAMETER,
    ElementType.TYPE_USE
})
public @interface MmdFileRef {
  /**
   * UID of some defined MmdFile. Defined non-empty UID has higher priority than the target attribute.
   *
   * @return UID which should be defined in a MmdFile annotation of a project class. Default value is empty one what means undefined.
   * @see MmdFile
   */
  String uid() default "";

  /**
   * Target class which should be marked ether by {@link MmdFile} or {@link @MmdFiles} annotation. First found one in class hierarchy will be used.
   * Keep in mind that if provided {@link MmdFileRef#uid()} attribute then UID has higher priority.
   *
   * @return a class to be used as target to search target mmd file.
   * @see MmdFile
   */
  Class target() default MmdFileRef.class;

  /**
   * Flag to make substitution for found {@code ${variable.name}} in all text based fields.
   * Supported variables depends on preprocessor, the standard one provides system properties as variables. If detected unknown variable then exception will be thrown.
   *
   * @return true if text fields should be substituted
   * @since 1.6.8
   * {@code  @MmdFileRef(substitute=true, uid="${os.name}-12345")}
   */
  boolean substitute() default false;
}