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.Immutable;
23  
24  import static org.apache.maven.api.ExtensibleEnums.language;
25  
26  /**
27   * Language.
28   * <p>
29   * This extensible enum has two defined values, {@link #NONE} and {@link #JAVA_FAMILY},
30   * but can be extended by registering a {@code org.apache.maven.api.spi.LanguageProvider}.
31   * <p>
32   * Implementation must have {@code equals()} and {@code hashCode()} implemented, so implementations of this interface
33   * can be used as keys.
34   *
35   * @since 4.0.0
36   */
37  @Experimental
38  @Immutable
39  @SuppressWarnings("checkstyle:InterfaceIsType")
40  public interface Language extends ExtensibleEnum {
41  
42      /**
43       * The "none" language. It is not versioned, family is same to itself, and compatible with itself only.
44       * In turn, every {@link Language} implementation must be compatible with {@code NONE} language.
45       */
46      Language NONE = language("none");
47  
48      // TODO: this should be moved out from here to Java Support (builtin into core)
49      Language JAVA_FAMILY = language("java");
50  }