|
InputOutput
and related interfaces used in
driving the Output Window. The normal implementation is org.netbeans.core.output2
.
Question (arch-overall):
Describe the overall architecture.
Answer:
InputOutputAPI
-
Just an API/SPI for defining the output window.
Question (arch-usecases): Describe the main use cases of the new API. Who will use it under what circumstances? What kind of code would typically need to be written to use the module? Answer:There is an SPI but additional implementations are not expected. The API is most important.
Simple usage example:
InputOutput io = IOProvider.getDefault().getIO("My Window", true); io.select(); OutputWriter w = io.getOut(); w.println("Line of plain text."); OutputListener listener = new OutputListener() { public void outputLineAction(OutputEvent ev) { StatusDisplayer.getDefault().setStatusText("Hyperlink clicked!"); } public void outputLineSelected(OutputEvent ev) { // Let's not do anything special. } public void outputLineCleared(OutputEvent ev) { // Leave it blank, no state to remove. } }; w.println("Line of hyperlinked text.", listener, true);Question (arch-time): What are the time estimates of the work? Answer:
Done.
Question (arch-quality): How will the quality of your code be tested and how are future regressions going to be prevented? Answer:Too little code to test.
Question (arch-where): Where one can find sources for your module? WARNING: Question with id="arch-where" has not been answered!
The default answer to this question is:
These modules are required in project.xml:
You will very likely also want to declare
OpenIDE-Module-Requires: org.openide.windows.IOProvider
to ensure that an Output Window implementation is in fact enabled.
java.io.File
directly?
Answer:
No, but the implementation may.
Question (resources-layer): Does your module provide own layer? Does it create any files or folders in it? What it is trying to communicate by that and with which components? Answer: No. Question (resources-read): Does your module read any resources from layers? For what purpose? Answer: No Question (resources-mask): Does your module mask/hide/override any resources provided by other modules in their layers? Answer: No Question (resources-preferences): Does your module uses preferences via Preferences API? Does your module use NbPreferences or or regular JDK Preferences ? Does it read, write or both ? Does it share preferences with other modules ? If so, then why ? WARNING: Question with id="resources-preferences" has not been answered!org.openide.util.Lookup
or any similar technology to find any components to communicate with? Which ones?
Answer:
IOProvider.getDefault()
asks lookup for the first instance
of itself. This is normally provided by org.netbeans.core.output2
.
Question (lookup-register):
Do you register anything into lookup for other code to find?
Answer:
No
Question (lookup-remove):
Do you remove entries of other modules from lookup?
Answer:
No
System.getProperty
) property?
On a similar note, is there something interesting that you
pass to java.util.logging.Logger
? Or do you observe
what others log?
Answer:
No
Question (exec-component):
Is execution of your code influenced by any (string) property
of any of your components?
Answer:
No
Question (exec-ant-tasks):
Do you define or register any ant tasks that other can use?
Answer:
No.
Question (exec-classloader): Does your code create its own class loader(s)? Answer: No Question (exec-reflection): Does your code use Java Reflection to execute other code? Answer: No Question (exec-privateaccess): Are you aware of any other parts of the system calling some of your methods by reflection? Answer: No Question (exec-process): Do you execute an external process from your module? How do you ensure that the result is the same on different platforms? Do you parse output? Do you depend on result code? Answer: No. Question (exec-introspection): Does your module use any kind of runtime type information (instanceof
,
work with java.lang.Class
, etc.)?
Answer:
No.
Question (exec-threading):
What threading models, if any, does your module adhere to? How the
project behaves with respect to threading?
Answer:
Should be thread safe.
Question (security-policy): Does your functionality require modifications to the standard policy file? Answer:No.
Question (security-grant): Does your code grant additional rights to some other code? Answer:No.
java.awt.datatransfer.Transferable
?
Answer:
Plain Unicode text only.
No special behavior.