io.takari.builder.InputFile Maven / Gradle / Ivy

Go to download
package io.takari.builder;

import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

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

/**
 * Identifies single input file parameter.
 */
@Target({FIELD})
@Retention(RUNTIME)
public @interface InputFile {

  /**
   * If {@code fileRequired=true}, the injected parameter value will be an existing regular file.
   * 
   * 
   * If {@code fileRequired=false}, the injected parameter value can be am existing regular file, a
   * file that does not exist or {@code null}, if no parameter configuration was provided.
   * 
   * @see Parameter#required()
   */
  boolean fileRequired() default false;

  /**
   * @see Parameter#value()
   */
  String[] value() default {};

  /**
   * @see Parameter#defaultValue()
   */
  String[] defaultValue() default {};

}