org.pragmaticminds.crunch.api.annotations.ChannelValue Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of crunch-api Show documentation

Programing Interfaces for other CRUNCH Projects.

The newest version!

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.pragmaticminds.crunch.api.annotations;

import org.pragmaticminds.crunch.api.records.DataType;

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

/**
 * This Annotation can be used on Fields of specific Type in an {@code EvaluationFunction}.
 * It indicates that the field will getValue the channel value injected.
 * Created by julian on 13.02.17.
 *
 * @deprecated Part of the old API
 */
@Deprecated
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface ChannelValue {

    /**
     * Name of the ChannelParameter that should be injected.
     *
     * @return the name of the channel as String
     */
    String name();

    /**
     * Type of the Channel.
     *
     * @return the data type of the channel as DataType
     */
    DataType dataType();
}