org.gridgain.grid.resources.GridTaskContinuousMapperResource Maven / Gradle / Ivy

Go to download
/* 
 Copyright (C) GridGain Systems. All Rights Reserved.
 
 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 org.gridgain.grid.resources;

import org.gridgain.grid.compute.*;

import java.lang.annotation.*;

/**
 * Annotates a field or a setter method for injection of
 * {@link GridComputeTaskContinuousMapper} resource.
 * 
 * Task continuous mapper can be injected into {@link GridComputeTask} class
 * instance.
 * 

 * Here is how injection would typically happen:
 * 
 * public class MyGridJob implements GridComputeJob {
 *      ...
 *      @GridTaskContinuousMapperResource
 *      private GridComputeTaskContinuousMapper mapper;
 *      ...
 *  }
 * 
 * or
 *  * public class MyGridJob implements GridComputeJob {
 *     ...
 *     private GridComputeTaskContinuousMapper mapper;
 *     ...
 *     @GridTaskContinuousMapperResource
 *     public void setMapper(GridComputeTaskContinuousMapper mapper) {
 *          this.mapper = mapper;
 *     }
 *     ...
 * }
 * 
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.FIELD})
public @interface GridTaskContinuousMapperResource {
    // No-op.
}