1 /* 2 * Copyright (c) 2010, 2017, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26 package javafx.fxml; 27 28 import java.lang.annotation.ElementType; 29 import java.lang.annotation.Retention; 30 import java.lang.annotation.RetentionPolicy; 31 import java.lang.annotation.Target; 32 33 /** 34 * Annotation that tags a field or method as accessible to markup. 35 * <p><b>Deploying an Application as a Module</b></p> 36 * <p> 37 * If the object being annotated is in a named module then it must 38 * be reflectively accessible to the {@code javafx.fxml} module. 39 * Otherwise, the {@link FXMLLoader} will fail with an 40 * {@code InaccessibleObjectException} when it attempts to modify the 41 * annotated element. 42 * An object is reflectively accessible if the module containing that 43 * object {@link Module#isOpen(String,Module) opens} the containing package to 44 * at least the 45 * {@code javafx.fxml} module. 46 * </p> 47 * <p> 48 * For example, if the object being annotated is in the {@code com.foo} 49 * package in the {@code foo.app} module, the {@code module-info.java} might 50 * look like this: 51 * </p> 52 * 53 <pre>{@code module foo.app { 54 opens com.foo to javafx.fxml; 55 }}</pre> 56 * 57 * <p> 58 * Alternatively, an object is reflectively accessible if it is declared 59 * as a public member, is in a public class, and the module containing that 60 * class {@link Module#isExported(String) exports} the containing 61 * package unconditionally. 62 * </p> 63 * 64 * @since JavaFX 2.0 65 */ 66 @Retention(RetentionPolicy.RUNTIME) 67 @Target({ElementType.FIELD, ElementType.METHOD}) 68 public @interface FXML { 69 }