src/com/facebook/buck/rules/Hint.java

/*
 * Copyright 2013-present Facebook, Inc.
 *
 * 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.facebook.buck.rules;

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

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


/**
 * Represents hints given when deal with the value returned by
 * {@link Description#createUnpopulatedConstructorArg()}.
 */
@Retention(RUNTIME)
@Target({FIELD, METHOD})
public @interface Hint {
  public static final String DEFAULT_NAME = "";
  public static final boolean DEFAULT_IS_DEP = true;

  /**
   * @return The name to use in preference to the field or property name (eg. "field_name")
   */
  String name() default DEFAULT_NAME;

  /**
   * @return Whether to search the field's value for dependencies
   */
  boolean isDep() default DEFAULT_IS_DEP;
}