This project has retired. For details please refer to its Attic page.
Algorithm xref
View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *     http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing, software
13   * distributed under the License is distributed on an "AS IS" BASIS,
14   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   * See the License for the specific language governing permissions and
16   * limitations under the License.
17   */
18  
19  package org.apache.giraph;
20  
21  import java.lang.annotation.ElementType;
22  import java.lang.annotation.Retention;
23  import java.lang.annotation.RetentionPolicy;
24  import java.lang.annotation.Target;
25  
26  /**
27   * This annotation should be used to annotate built-in algorithms.
28   */
29  @Retention(value = RetentionPolicy.RUNTIME)
30  @Target(value = ElementType.TYPE)
31  public @interface Algorithm {
32    // CHECKSTYLE: stop JavadocMethod
33    /**
34     * Name of the algorithm.
35     * @return Name
36     */
37    String name();
38  
39    /**
40     * Short description of algorithm which is going to be presented to the user.
41     * @return Description
42     */
43    String description() default "";
44    // CHECKSTYLE: resume JavadocMethod
45  }