diff --git a/spi.java.hints/src/org/netbeans/spi/java/hints/IntegerOption.java b/spi.java.hints/src/org/netbeans/spi/java/hints/IntegerOption.java new file mode 100644 --- /dev/null +++ b/spi.java.hints/src/org/netbeans/spi/java/hints/IntegerOption.java @@ -0,0 +1,99 @@ +/* + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. + * + * Copyright 2013 Oracle and/or its affiliates. All rights reserved. + * + * Oracle and Java are registered trademarks of Oracle and/or its affiliates. + * Other names may be trademarks of their respective owners. + * + * The contents of this file are subject to the terms of either the GNU + * General Public License Version 2 only ("GPL") or the Common + * Development and Distribution License("CDDL") (collectively, the + * "License"). You may not use this file except in compliance with the + * License. You can obtain a copy of the License at + * http://www.netbeans.org/cddl-gplv2.html + * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the + * specific language governing permissions and limitations under the + * License. When distributing the software, include this License Header + * Notice in each file and include the License file at + * nbbuild/licenses/CDDL-GPL-2-CP. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the GPL Version 2 section of the License file that + * accompanied this code. If applicable, add the following below the + * License Header, with the fields enclosed by brackets [] replaced by + * your own identifying information: + * "Portions Copyrighted [year] [name of copyright owner]" + * + * If you wish your version of this file to be governed by only the CDDL + * or only the GPL Version 2, indicate your decision by adding + * "[Contributor] elects to include this software in this distribution + * under the [CDDL or GPL Version 2] license." If you do not indicate a + * single choice of license, a recipient has the option to distribute + * your version of this file under either the CDDL, the GPL Version 2 or + * to extend the choice of license to its licensees as provided above. + * However, if you add GPL Version 2 code and therefore, elected the GPL + * Version 2 license, then the option applies only if the new code is + * made subject to such option by the copyright holder. + * + * Contributor(s): + * + * Portions Copyrighted 2013 Sun Microsystems, Inc. + */ +package org.netbeans.spi.java.hints; + +import java.lang.annotation.Documented; +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +/** + * Declares an int-value option that affects hint processing. + * If the Hint mixes integer and boolean options, the integer options + * come first, boolean second in the UI. + * + * @author sdedic + */ +@Retention(RetentionPolicy.SOURCE) +@Target(ElementType.FIELD) +@Documented +public @interface IntegerOption { + /** + * @return Display name of the option + */ + public String displayName(); + + /** + * @return tooltip for mouse hover over the option + */ + public String tooltip() default ""; + + /** + * @return default value for the option + */ + public int defaultValue() default 0; + + /** + * Minimum value for the option. If Integer.MIN_VALUE (the default), + * no minimum will be enforced. + * + * @return minimum value. + */ + public int minValue() default 0; + + /** + * Maximum value for the option. If Integer.MAX_VALUE (the default), + * no maximum will be enforced. Please do choose a reasonable maximum value, + * as the UI may size the input box to accommodate all digits of the maximum + * permitted value, and the input box may seem unreasonably large. + * + * @return maximum value + */ + public int maxValue() default Integer.MAX_VALUE; + + /** + * If non-zero, a spinner will be created with the specified step. If zero (the default), + * a plain input will be presented. Negative values are not accepted at the moment and are reserved. + */ + public int step() default 0; +}