View Javadoc

1   /*
2    * Copyright 2010 the original author or authors.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package org.callbackparams.combine.annotation;
18  
19  import java.lang.annotation.Documented;
20  import java.lang.annotation.ElementType;
21  import java.lang.annotation.Inherited;
22  import java.lang.annotation.Retention;
23  import java.lang.annotation.RetentionPolicy;
24  import java.lang.annotation.Target;
25  import org.callbackparams.combine.CombineStrategy;
26  
27  /**
28   * Using this annotation is the recommended practise for configuring the
29   * automated combining of callback-values into callback-records.
30   * @see CombineStrategy
31   * 
32   * @author Henrik Kaipe
33   */
34  @Retention(RetentionPolicy.RUNTIME)
35  @Target(ElementType.TYPE)
36  @Inherited
37  @Documented
38  public @interface CombineConfig {
39  
40      /**
41       * Specifies the combine-strategy implementation class.
42       * The specified class must have a default (no-arg) constructor.
43       */
44      Class<? extends CombineStrategy> strategy();
45  
46      /**
47       * @see CombineStrategy#setMaxCount(int)
48       */
49      int maxCount() default -1;
50  
51      /**
52       * @see CombineStrategy#setRandomSeed(long)
53       */
54      long randomSeed() default -1;
55  }