View Javadoc
1   /*
2    * Copyright (c) 2002-2025 Gargoyle Software Inc.
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    * https://www.apache.org/licenses/LICENSE-2.0
8    *
9    * Unless required by applicable law or agreed to in writing, software
10   * distributed under the License is distributed on an "AS IS" BASIS,
11   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12   * See the License for the specific language governing permissions and
13   * limitations under the License.
14   */
15  package org.htmlunit.javascript.configuration;
16  
17  import static org.htmlunit.javascript.configuration.SupportedBrowser.CHROME;
18  import static org.htmlunit.javascript.configuration.SupportedBrowser.EDGE;
19  import static org.htmlunit.javascript.configuration.SupportedBrowser.FF;
20  import static org.htmlunit.javascript.configuration.SupportedBrowser.FF_ESR;
21  
22  import java.lang.annotation.ElementType;
23  import java.lang.annotation.Repeatable;
24  import java.lang.annotation.Retention;
25  import java.lang.annotation.RetentionPolicy;
26  import java.lang.annotation.Target;
27  
28  /**
29   * An annotation to mark a Java class as JavaScript class.
30   *
31   * @author Ahmed Ashour
32   * @author Ronald Brill
33   */
34  @Retention(RetentionPolicy.RUNTIME)
35  @Target(ElementType.TYPE)
36  @Repeatable(JsxClasses.class)
37  public @interface JsxClass {
38  
39      /**
40       * The DOM class (if any).
41       * @return the DOM class
42       */
43      Class<?> domClass() default Object.class;
44  
45      /**
46       * Is JavaScript Object.
47       * @return is JavaScript Object
48       */
49      boolean isJSObject() default true;
50  
51      /**
52       * The class name.
53       * @return the class name
54       */
55      String className() default "";
56  
57      /**
58       * The {@link SupportedBrowser}s supported by this constant.
59       * @return the {@link SupportedBrowser}s
60       */
61      SupportedBrowser[] value() default {
62          CHROME,
63          EDGE,
64          FF,
65          FF_ESR
66      };
67  }