com.addhen.android.raiburari.annotations.Transform Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2016 Henry Addo
 *
 * 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.addhen.android.raiburari.annotations;

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

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

/**
 * @author Henry Addo
 */

@Retention(SOURCE) @Documented @Target({ FIELD }) public @interface Transform {

  /**
   * The corresponding variable name of the class being transformed into.
   *
   * @return The variable name
   */
  String name();

  /**
   * The Transformer class to be used to transform the object field to its corresponding
   * class type.
   *
   * @return The class name of the transformer. Usually it ends with Transformer.
   */
  String transformer() default "";
}