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,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.maven.api;
20  
21  import org.apache.maven.api.annotations.Experimental;
22  import org.apache.maven.api.annotations.Nonnull;
23  
24  /**
25   * Interface that defines some kind of enums that can be extended by Maven plugins or extensions.
26   *
27   * Implementation must have {@code equals()} and {@code hashCode()} implemented, so implementations of this interface
28   * can be used as keys.
29   *
30   * @since 4.0.0
31   */
32  @Experimental
33  public interface ExtensibleEnum {
34  
35      /**
36       * The {@code id} uniquely represents a value for this extensible enum.
37       * This id should be used to compute the equality and hash code for the instance.
38       *
39       * @return the id
40       */
41      @Nonnull
42      String id();
43  }