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 * If the object being annotated is in a named module then it must 36 * be reflectively accessible to the {@code javafx.fxml} module. 37 * Otherwise, the {@link FXMLLoader} will fail with an 38 * {@code InaccessibleObjectException} when it attempts to modify the 39 * annotated element. 40 * An object is reflectively accessible if the module containing that 41 * object {@link Module#isOpen(String,Module) opens} the containing package to 42 * at least the 43 * {@code javafx.fxml} module. 44 * <p> 45 * For example, if the object being annotated is in the {@code com.foo} 46 * package in the {@code foo.app} module, the {@code module-info.java} might 47 * look like this: 48 * </p> 49 * 50 <pre>{@code module foo.app { 51 opens com.foo to javafx.fxml; 52 }}</pre> 53 * 54 * <p> 55 * Alternatively, an object is also reflectively accessible if it is declared 56 * as a public member, is in a public class, and the module containing that 57 * class {@link Module#isExported(String) exports} the containing 58 * package unconditionally. 59 * </p> 60 * 61 * @since JavaFX 2.0 62 */ 63 @Retention(RetentionPolicy.RUNTIME) 64 @Target({ElementType.FIELD, ElementType.METHOD}) 65 public @interface FXML { 66 }