+ The module contains APIs for creating output panes (e.g. output tabs in Output Window in the IDE) + and for writing data into them. It also supports some advanced techniques, e.g. color text, + hyperlinks, code folding, scrolling to stored positions. +
+
+ SPI for providing custom implementations of output window is also included in this module, in package
+ org.netbeans.spi.io
+
+ Unit test will be prepared for invocable code in API classes. But most of the + code is just definition of API and SPI. +
++ The design, implementation, preparing unit tests and reviews will + probably take several weeks. +
++ The basic use-case is printing a simple text, e.g. text output of an application, + into a dedicated pane in the UI, e.g. a tab in Output Window in the IDE. +
+
+ InputOutput io = InputOutput.get("UseCase1", true);
+ io.getOut().println("This is a simple output");
+ io.getOut().close();
+
+ + Implementations can support hyperlinks. If the hyperlink is defined by a URI, + it will be opened by the UI part of the application when the hyperlink is clicked + in the output window. The following example will open a file and place the cursor + at line and column specified by query part of the URI (after question mark). +
+
+ InputOutput io = InputOutput.get("UseCase2", false);
+ io.getOut().print("A line containing a ");
+ io.getOut().print("hyperlink", Hyperlink.forURI(new URI("file://n:/test/Test.java?line=4&col=2")));
+ io.getOut().println(" for a URI.");
+ io.getOut().close();
+
+ + Hyperlinks can be also used to invoke some code when clicked. +
+
+ InputOutput io = InputOutput.get("UseCase3", true);
+ io.getOut().print("A line containing a ");
+ io.getOut().print("hyperlink", Hyperlink.onClick(new Runnable() {
+ public void run() {
+ System.gc();
+ }
+ }));
+ io.getOut().println(" for invocation of custom code.");
+ io.getOut().close();
+
+ + Print a color text. Users can select a predefined color for + common cases (debug, warning, failure, success), or custom + color specified as RGB value. +
+
+ InputOutput io = InputOutput.get("UseCase4", true);
+ io.getOut().println("Let's print some info", OutputColor.debug());
+ io.getOut().println("or warning with appropriate color", OutputColor.warning());
+ io.getOut().println("Maybe also text with custom reddish color", OutputColor.rgb(255, 16, 16));
+ io.getOut().close();
+
+ + It is possible to reuse already created output pane and clear + all the previously printed text if it is not needed any more. +
+
+ InputOutput io = InputOutput.get("UseCase5", true);
+ io.getOut().println("Let's print some text");
+ io.getErr().println("and reset the pane immediately.");
+ io.reset();
+ io.getOut().println("The pane is now empty and we can reuse it simply");
+ io.getOut().close();
+
+
+ The Input/Output API and SPI is a small module
+ which contains InputOutput and related interfaces used in
+ driving the Output Window.
+
+ The normal implementation is org.netbeans.core.output2.
+
+ Backward compatibility of other modules is not broken. +
+
+ This module should replace original I/O API module
+ org.openide.io, which has the same goals, but which is
+ not UI independent, and which is difficult to extend.
+
+ Yes. There is not much to internationalize. +
++ The module defines an API. +
++ N/A. No settings are read or written by this module. +
++ You will very likely also want to declare +
+OpenIDE-Module-Requires: org.netbeans.api.io.IOProvider+
to ensure that an Output Window implementation is in fact enabled.
++ Just the module JAR. +
++ Yes. +
++ No; only API classes are public. +
++ Anywhere. +
++ No. +
++ No. +
++ No. +
++ No. +
++ No. +
++ No. +
++ No. +
++ No. +
++ Should be thread safe. +
++ Plain Unicode text only. +
++ N/A +
++ None. +
+
+ IOProvider.getDefault() asks lookup for the first instance
+ of InputOutputProvider. This is normally provided by
+ org.netbeans.core.output2.
+
+ No. +
++ No. +
++ No. +
++ No. +
++ No. +
++ N/A +
++ No. +
++ No. +
++ Scalability in GUI speed and memory consumption is probably limited + only by the Output Window implementation. +
++ No special behavior. +
++ No. +
++ No. +
++ No, but the implementation may. +
++ No. +
++ No. +
++ No. +
++ No. +
++ No. +
++ No. +
+IOProvider.getDefault().getIO("MyTab", false) (pass true if
+ * there may be an existing tab with the same name and you want to write to a
+ * new tab).
+ *
+ * @author Jesse Glick, Jaroslav Havlin
+ */
+public abstract class IOProvider {
+
+ private IOProvider() {
+ }
+
+ /**
+ * Get the default I/O provider.
+ * + * Normally this is taken from {@link Lookup#getDefault} but if there is no + * instance in lookup, a fallback instance is created which just uses the + * standard system I/O streams. This is useful for unit tests and perhaps + * for standalone usage of various libraries. + *
+ * + * @return The default instance (never null). + */ + @NonNull + public static IOProvider getDefault() { + InputOutputProvider def = Lookup.getDefault().lookup(InputOutputProvider.class); + if (def != null) { + return wrapProvider(def); + } else { + return wrapProvider(new Trivial()); + } + } + + private staticInputOutput is
+ * returned, else an existing InputOutput of the same name may
+ * be returned.
+ * @return An InputOutput instance for accessing the new tab.
+ * @see InputOutput
+ */
+ @NonNull
+ public abstract InputOutput getIO(@NonNull String name, boolean newIO);
+
+ /**
+ * Get a named instance of InputOutput, which represents an output tab in
+ * the output window. Streams for reading/writing can be accessed via
+ * getters on the returned instance.
+ *
+ * @param name A localised display name for the tab.
+ * @param newIO If true, a new InputOutput is
+ * returned, else an existing InputOutput of the same name may
+ * be returned.
+ * @param lookup Lookup which may contain additional information for various
+ * implementations of output window.
+ * @return An InputOutput instance for accessing the new tab.
+ * @see InputOutput
+ */
+ @NonNull
+ public abstract InputOutput getIO(@NonNull String name, boolean newIO,
+ @NonNull Lookup lookup);
+
+ /**
+ * Implementation of IOProvider that uses {@link InputOutputProvider} SPI
+ * internally.
+ *
+ * @param
+ * @param
+ */
+ private static class ImplIOProvider.getDefault().getInputOutput("someName", false). To
+ * get actual streams to write to, call getOut() or
+ * getErr() on the returned instance.
+ * + * Generally it is preferable not to hold a reference to an instance of + * {@link org.netbeans.api.io.InputOutput}, but rather to fetch it by name from + * {@link org.netbeans.api.io.IOProvider} as needed. + *
+ * + * @see OutputWriter + * @author Ian Formanek, Jaroslav Tulach, Petr Hamernik, Ales Novak, Jan + * Jancura, Jaroslav Havlin + */ +public abstract class InputOutput implements Lookup.Provider { + + private InputOutput() { + } + + /** + * Get a named instance of InputOutput from the default {@link IOProvider}, + * which represents an output tab in the output window. Streams for + * reading/writing can be accessed via getters on the returned instance. + * + *+ * This is a shorthand for {@code IOProvider.getDefault().getIO(...)}. + *
+ * + * @param name A localised display name for the tab. + * @param newIO If true, a newInputOutput is
+ * returned, else an existing InputOutput of the same name may
+ * be returned.
+ * @return An InputOutput instance for accessing the new tab.
+ * @see IOProvider
+ */
+ @NonNull
+ public static InputOutput get(@NonNull String name, boolean newIO) {
+ return IOProvider.getDefault().getIO(name, newIO);
+ }
+
+ /**
+ * Get a named instance of InputOutput from the default {@link IOProvider},
+ * which represents an output tab in the output window. Streams for
+ * reading/writing can be accessed via getters on the returned instance.
+ *
+ * + * This is a shorthand for {@code IOProvider.getDefault().getIO(...)}. + *
+ * + * @param name A localised display name for the tab. + * @param newIO If true, a newInputOutput is
+ * returned, else an existing InputOutput of the same name may
+ * be returned.
+ * @param lookup Lookup which may contain additional information for various
+ * implementations of output window.
+ * @return An InputOutput instance for accessing the new tab.
+ * @see IOProvider
+ */
+ @NonNull
+ public static InputOutput get(@NonNull String name, boolean newIO,
+ @NonNull Lookup lookup) {
+ return IOProvider.getDefault().getIO(name, newIO, lookup);
+ }
+
+ /**
+ * Get a reader to read from the tab.
+ *
+ * @return The reader.
+ */
+ @NonNull
+ public abstract Reader getIn();
+
+ /**
+ * Acquire an output writer to write to the tab.
+ *
+ * @return The writer.
+ */
+ @NonNull
+ public abstract OutputWriter getOut();
+
+ /**
+ * Get an output writer to write to the tab in error mode. This might show
+ * up in a different color than the regular output, e.g., or appear in a
+ * separate pane.
+ *
+ * @return The writer.
+ */
+ @NonNull
+ public abstract OutputWriter getErr();
+
+ /**
+ * Clear the output pane.
+ */
+ public abstract void reset();
+
+ /**
+ * Get lookup which may contain extensions provided by implementation of
+ * output window.
+ *
+ * @return The lookup.
+ */
+ @NonNull
+ @Override
+ public abstract Lookup getLookup();
+
+ /**
+ * Closes this tab. The effect of calling any method on an instance of
+ * InputOutput after calling closeInputOutput() on it is
+ * undefined.
+ */
+ public abstract void closeInputOutput();
+
+ /**
+ * Test whether this tab has been closed, either by a call to
+ * {@link #closeInputOutput()} or by the user closing the tab in the UI.
+ *
+ * @return Value true if it is closed.
+ */
+ public abstract boolean isClosed();
+
+ /**
+ * Select this I/O, if possible (e.g. in tabbed pane). Do not open the
+ * output window if it is currently closed.
+ */
+ public abstract void select();
+
+ /**
+ * Select and show this I/O, if possible (e.g. display minimized panel).
+ * Please note that this can be quite disturbing for the users, so please
+ * use with caution.
+ */
+ public abstract void show();
+
+ /**
+ * Select, show and activate (focus) this I/O, if possible. Please note that
+ * this can be quite disturbing for the users, so please use with caution.
+ */
+ public abstract void activate();
+
+ static + * Although using wide range of custom RGB colors may be tempting, predefined + * colors are recommended, as they can be configured to respect GUI theme in + * use. + *
+ * + * @author jhavlin + */ +public abstract class OutputColor { + + /** + * Type of the color - static (rgb) or dynamic. Visibility is public as it + * may be convenient for the implementators of {@link InputOutputProvider}. + *+ * Note: New items may be added in the future. + *
+ */ + @SuppressWarnings("PublicInnerClass") + public enum Type { + WARNING, FAILURE, DEBUG, SUCCESS, RGB + } + + private final Type type; + private static final OutputColor CLR_WARNING = new TypeColor(Type.WARNING); + private static final OutputColor CLR_FAILURE = new TypeColor(Type.FAILURE); + private static final OutputColor CLR_DEBUG = new TypeColor(Type.DEBUG); + private static final OutputColor CLR_SUCCESS = new TypeColor(Type.SUCCESS); + + private OutputColor(Type type) { + this.type = type; + } + + /** + * Get RGB value for an {@link OutputColor} specified for a constant RGB + * color. + * + * @return RGB value of the color, or some undefined value if the + * {@link OutputColor} was created for a predefined color, not for constant + * RGB value. + */ + public abstract int getRGB(); + + /** + * Get type of this color. + * + * @return Some of predefined text types, or {@link Type#RGB} for colors + * created for constant RGB values. + */ + @NonNull + public Type getType() { + return this.type; + } + + /** + * Warning text color. + * + * @return Predefined color for text of type "warning". + */ + @NonNull + public static OutputColor warning() { + return CLR_WARNING; + } + + /** + * Failure text color. + * + * @return Predefined color for text of type "failure". + */ + @NonNull + public static OutputColor failure() { + return CLR_FAILURE; + } + + /** + * Debug text color. + * + * @return Predefined color for text of type "debug". + */ + @NonNull + public static OutputColor debug() { + return CLR_DEBUG; + } + + /** + * Success text color. + * + * @return Predefined color for text of type "success". + */ + @NonNull + public static OutputColor success() { + return CLR_SUCCESS; + } + + /** + * Arbitrary constant RGB color. + * + *+ * Please note that it is recommended to use colors for predefined text + * types, which can respect color theme used by the GUI. + *
+ * + * @param r The red component, in the range (0 - 255). + * @param g The green component, in the range (0 - 255). + * @param b The blue component, in the range (0 - 255). + * + * @return Color specified for a constant RGB value. + * @throws IllegalArgumentException If some of color components is out of + * range. + */ + @NonNull + public static OutputColor rgb(int r, int g, int b) { + checkColorComponentRange("r", r); + checkColorComponentRange("g", g); + checkColorComponentRange("b", b); + int value = ((r & 0xFF) << 16) + | ((g & 0xFF) << 8) + | ((b & 0xFF)); + return rgb(value); + } + + /** + * Arbitrary constant RGB color. Creates an opaque sRGB color with the + * specified combined RGB value consisting of the red component in bits + * 16-23, the green component in bits 8-15, and the blue component in bits + * 0-7. + * + *+ * Please note that it is recommended to use colors for predefined text + * types, which can respect color theme used by the GUI. + *
+ * + * @param rgbValue The combined RGB components. + * + * @return Color specified for a constant RGB value. + */ + @NonNull + public static OutputColor rgb(int rgbValue) { + return new RgbColor(rgbValue); + } + + private static void checkColorComponentRange(String name, + int colorComponent) { + + if (colorComponent < 0 || colorComponent > 255) { + throw new IllegalArgumentException("Color component " + name//NOI18N + + " is out of range (0 - 255): " + colorComponent); //NOI18N + } + } + + private static class TypeColor extends OutputColor { + + public TypeColor(Type type) { + super(type); + } + + @Override + public int getRGB() { + return 0; + } + } + + private static class RgbColor extends OutputColor { + + private final int value; + + public RgbColor(int value) { + super(Type.RGB); + this.value = value; + } + + @Override + public int getRGB() { + return value; + } + } +} diff --git a/api.io/src/org/netbeans/api/io/OutputWriter.java b/api.io/src/org/netbeans/api/io/OutputWriter.java new file mode 100644 --- /dev/null +++ b/api.io/src/org/netbeans/api/io/OutputWriter.java @@ -0,0 +1,307 @@ +/* + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. + * + * Copyright 2014 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 2014 Sun Microsystems, Inc. + */ +package org.netbeans.api.io; + +import java.io.IOException; +import java.io.PrintWriter; +import java.io.Writer; +import java.util.Locale; +import org.netbeans.spi.io.InputOutputProvider; + +/** + * + * @author jhavlin + */ +public abstract class OutputWriter extends PrintWriter { + + private OutputWriter() { + super(new DummyWriter()); + } + + public abstract void print(String s, Hyperlink link, OutputColor color); + + public abstract void print(String s, Hyperlink link); + + public abstract void print(String s, OutputColor color); + + public abstract void println(String s, Hyperlink link, OutputColor color); + + public abstract void println(String s, Hyperlink link); + + public abstract void println(String s, OutputColor color); + + static+ * Use {@link ServiceProvider} annotation for registration. + *
+ * + * @author jhavlin + * + * @param+ * If the implementation doesn't support this feature, this method should + * call something like + * {@code writer.print(text); if (printLineEnd) {writer.println();}}. + *
+ * + * @param io The I/O instance. + * @param writer The Stream to write into. + * @param text Text to print. + * @param link Link which should be represented by the text, can be null for + * standard text. + * @param color Color of the text, can be null for the default color of the + * stream. + * @param printLineEnd True if new-line should be appended after printing + * {code text}. + */ + void print(@NonNull IO io, @NonNull WRITER writer, @NullAllowed String text, + @NullAllowed Hyperlink link, @NullAllowed OutputColor color, + boolean printLineEnd); + + /** + * Get lookup of an I/O instance, which can contain various extensions and + * additional info. + * + * @param io The I/O instance. + * + * @return The lookup, which can be empty, but never null. + */ + @NonNull + Lookup getIOLookup(@NonNull IO io); + + /** + * Reset the I/O. Clear previously written data and prepare it for new data. + *+ * If the implementation doesn't support this feature, this method should do + * nothing. + *
+ * + * @param io The I/O instance. + */ + void resetIO(@NonNull IO io); + + /** + * Select the I/O instance, but do not show it if it is currently hidden. + * This is useful if several output panes are inside a tabbed pane, and the + * tab representing {@code io} should be selected. + *+ * If the implementation doesn't support this feature, this method should do + * nothing. + *
+ * + * @param io The I/O instance. + * + * @see #showIO(java.lang.Object) + * @see #activateIO(java.lang.Object) + */ + void selectIO(IO io); + + /** + * Show output pane for the passed I/O instance. + *+ * If the implementation doesn't support this feature, this method should do + * nothing. + *
+ * + * @param io The I/O instance. + * + * @see #selectIO(java.lang.Object) + * @see #activateIO(java.lang.Object) + */ + void showIO(IO io); + + /** + * Activate (focus) output pane for the passed I/O instance. + *+ * If the implementation doesn't support this feature, this method can at + * least show the output pane, or do nothing. + *
+ * + * @param io The I/O instance. + * + * @see #selectIO(java.lang.Object) + * @see #showIO(java.lang.Object) + */ + void activateIO(IO io); + + /** + * Close the I/O, its output pane and release resources. + * + * @param io The I/O instance. + * + * @see #isIOClosed(java.lang.Object) + */ + void closeIO(IO io); + + /** + * Check whether the I/O is closed. + * + * @param io The I/O instance. + * + * @return True if the I/O was closed, false otherwise. + * + * @see #closeIO(java.lang.Object) + */ + boolean isIOClosed(IO io); +} diff --git a/api.io/src/org/netbeans/spi/io/Utilities.java b/api.io/src/org/netbeans/spi/io/Utilities.java new file mode 100644 --- /dev/null +++ b/api.io/src/org/netbeans/spi/io/Utilities.java @@ -0,0 +1,70 @@ +/* + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. + * + * Copyright 2014 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 2014 Sun Microsystems, Inc. + */ +package org.netbeans.spi.io; + +import org.netbeans.spi.io.hyperlink.OpenUriHandler; +import java.net.URI; +import org.openide.util.Lookup; + +/** + * Utility methods for implementations of output window. + * + * @author jhavlin + */ +public final class Utilities { + + /** + * Handle the URI when a URI hyperlink is clicked in the output window. + * + * @param uri The URI to handle. + */ + public static void handleUri(URI uri) { + + for (OpenUriHandler handler + : Lookup.getDefault().lookupAll(OpenUriHandler.class)) { + + if (handler.handle(uri)) { + return; + } + } + } +} diff --git a/api.io/src/org/netbeans/spi/io/hyperlink/OpenUriHandler.java b/api.io/src/org/netbeans/spi/io/hyperlink/OpenUriHandler.java new file mode 100644 --- /dev/null +++ b/api.io/src/org/netbeans/spi/io/hyperlink/OpenUriHandler.java @@ -0,0 +1,68 @@ +/* + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. + * + * Copyright 2014 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 2014 Sun Microsystems, Inc. + */ +package org.netbeans.spi.io.hyperlink; + +import java.net.URI; + +/** + * SPI for handlers that can process URI hyperlinks that were clicked in the + * Output Window. + * + * If the front-end and back-end of the application is separated, clicked URI + * hyperlinks can be handled on the front-end, possibly without any + * communication with the back-end. + * + * @author jhavlin + */ +public interface OpenUriHandler { + + /** + * Handle the passed URI, if it is supported by this handler. + * + * @param uri The URI to handle. + * + * @return True if the URI has been handled succesfully, false if this + * handler doesn't support it and thus it should be passed to next available + * handler. + */ + boolean handle(URI uri); +} diff --git a/api.io/test/unit/src/org/netbeans/api/io/HyperlinkTest.java b/api.io/test/unit/src/org/netbeans/api/io/HyperlinkTest.java new file mode 100644 --- /dev/null +++ b/api.io/test/unit/src/org/netbeans/api/io/HyperlinkTest.java @@ -0,0 +1,101 @@ +/* + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. + * + * Copyright 2014 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 2014 Sun Microsystems, Inc. + */ +package org.netbeans.api.io; + +import java.net.URI; +import java.net.URISyntaxException; +import static org.junit.Assert.*; +import org.junit.Test; + +/** + * + * @author jhavlin + */ +public class HyperlinkTest { + + @Test + public void testUriLink() throws URISyntaxException { + Hyperlink h = Hyperlink.forURI(new URI("file://x")); + assertTrue(h.isForURI()); + assertFalse(h.isOnClick()); + assertFalse(h.isImportant()); + assertNotNull(h.getURI()); + assertNull(h.getRunnable()); + assertEquals("file://x", h.getURI().toString()); + } + + @Test + public void testUriLinkImportant() throws URISyntaxException { + Hyperlink h = Hyperlink.forURI(new URI("file://x"), true); + assertTrue(h.isImportant()); + } + + @Test + public void testOnClickLink() { + + final boolean[] invoked = new boolean[1]; + Hyperlink h = Hyperlink.onClick(new Runnable() { + + @Override + public void run() { + invoked[0] = true; + } + }); + assertFalse(h.isForURI()); + assertTrue(h.isOnClick()); + assertFalse(h.isImportant()); + assertNull(h.getURI()); + assertNotNull(h.getRunnable()); + h.getRunnable().run(); + assertTrue("The passed code should be invoked", invoked[0]); + } + + @Test + public void testOnClickLinkImportant() { + Hyperlink h = Hyperlink.onClick(new Runnable() { + @Override + public void run() { + } + }, true); + assertTrue(h.isImportant()); + } +} diff --git a/api.io/test/unit/src/org/netbeans/api/io/IOProviderTest.java b/api.io/test/unit/src/org/netbeans/api/io/IOProviderTest.java new file mode 100644 --- /dev/null +++ b/api.io/test/unit/src/org/netbeans/api/io/IOProviderTest.java @@ -0,0 +1,252 @@ +/* + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. + * + * Copyright 2014 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 2014 Sun Microsystems, Inc. + */ +package org.netbeans.api.io; + +import java.io.PrintWriter; +import java.io.Reader; +import java.io.StringReader; +import java.io.StringWriter; +import java.net.URI; +import java.net.URISyntaxException; +import java.util.ArrayList; +import org.junit.Test; +import static org.junit.Assert.*; +import org.netbeans.junit.MockServices; +import org.netbeans.spi.io.InputOutputProvider; +import org.openide.util.Lookup; +import org.openide.util.lookup.Lookups; + +/** + * + * @author jhavlin + */ +public class IOProviderTest { + + public IOProviderTest() { + } + + @Test + public void useCase1() { + InputOutput io = IOProvider.getDefault().getIO("UseCase1", true); + io.getOut().println("This is a simple output"); + io.getOut().close(); + } + + @Test + public void useCase2() throws URISyntaxException { + InputOutput io = IOProvider.getDefault().getIO("UseCase2", false); + io.getOut().print("A line containing a "); + io.getOut().print("hyperlink", Hyperlink.forURI(new URI( + "file://n:/test/Test.java?line=4&col=2"))); + io.getOut().println(" for a URI."); + io.getOut().close(); + } + + @Test + public void useCase3() { + InputOutput io = IOProvider.getDefault().getIO("UseCase3", true); + io.getOut().print("A line containing a "); + io.getOut().print("hyperlink", Hyperlink.onClick(new Runnable() { + @Override + public void run() { + System.gc(); + } + })); + io.getOut().println(" for invokation of custom code."); + io.getOut().close(); + } + + @Test + public void useCase4() { + InputOutput io = IOProvider.getDefault().getIO("UseCase4", true); + io.getOut().println("Let's print some info", OutputColor.debug()); + io.getOut().println("or warning with appropriate color", + OutputColor.warning()); + io.getOut().println("Maybe also text with custom reddish color", + OutputColor.rgb(255, 16, 16)); + io.getOut().close(); + } + + @Test + public void useCase5() { + InputOutput io = IOProvider.getDefault().getIO("UseCase5", true); + io.getOut().println("Let's print some text"); + io.getErr().println("and reset the pane immediately."); + io.reset(); + io.getOut().println("The pane is now empty and we can reuse it simply"); + io.getOut().close(); + } + + @Test + public void testTrivialImplementationAlwaysAvailable() { + assertEquals("Trivial", IOProvider.getDefault().getName()); + assertEquals("Trivial", IOProvider.get("Trivial").getName()); + assertEquals("Trivial", IOProvider.get("Another").getName()); + } + + @Test + public void testGetFromLookup() { + MockServices.setServices(MockInputOutputProvider.class); + try { + assertEquals("mock", IOProvider.getDefault().getName()); + assertEquals("mock", IOProvider.get("mock").getName()); + assertEquals("mock", IOProvider.get("wrong").getName()); + } finally { + MockServices.setServices(); + } + } + + @Test + public void testAllMethodsAreDelegatedToSPI() { + MockServices.setServices(MockInputOutputProvider.class); + try { + IOProvider.getDefault().getIO("test1", true); + Lookup lkp = IOProvider.getDefault() + .getIO("test1", false, Lookup.EMPTY).getLookup(); + CalledMethodList list = lkp.lookup(CalledMethodList.class); + assertEquals("getIO", list.get(0)); + assertEquals("getIO", list.get(1)); + assertEquals("getIOLookup", list.get(2)); + assertEquals(3, list.size()); + } finally { + MockServices.setServices(); + } + } + + @SuppressWarnings("PackageVisibleInnerClass") + static class CalledMethodList extends ArrayList