| net.refractions.udig.core.internal.CorePlugin
| CorePlugin | | public class CorePlugin extends Plugin (Code) | | PlugIn for net.refractions.udig.core, used by utility classes to access workbench log.
author:
jones
since:
0.3 |
| Field Summary | |
| final public static String | ID
| | final public static URLStreamHandler | RELAXED_HANDLER
A url stream handler that delegates to the default one but if it doesn't work then it returns null as the stream. |
| Method Summary | |
| public static MutablePicoContainer | getBlackBoard()
This is intended to return the top level Pico Container to use for blackBoarding.
For most applications, a sub container is required. | | public static CorePlugin | getDefault()
| | public static boolean | isDebugging(String trace)
Performs the Platform.getDebugOption true check on the provided trace
Note: ProjectUIPlugin.getDefault().isDebugging() must also be on. | | public static boolean | isDeveloping()
| | public static void | log(String message2, Throwable e)
Writes an info log in the plugin's log. | | public void | start(BundleContext context)
| | public static List<URL> | stringsToURLs(String string)
| | public static List<URL> | stringsToURLs(String[] strings)
Converts each element of an array from a String to a URL. | | public static void | trace(String message, Throwable e)
|
| RELAXED_HANDLER | | final public static URLStreamHandler RELAXED_HANDLER(Code) | | A url stream handler that delegates to the default one but if it doesn't work then it returns null as the stream.
|
| CorePlugin | | public CorePlugin()(Code) | | creates a plugin instance
|
| getBlackBoard | | public static MutablePicoContainer getBlackBoard()(Code) | | This is intended to return the top level Pico Container to use for blackBoarding.
For most applications, a sub container is required. I recommend the following code be
inserted into your main plugin class.
private static MutablePicoContainer myContainer = null;
/**
Gets the container for my plugin.
Make it 'public' if you want to share ... protected otherwise.
/
public static MutablePicoContainer getMyContainer(){
if(myContainer == null){
// XXXPlugin is the name of the Plugin class
synchronized(XXXPlugin.class){
// check so see that you were not queued for double creation
if(myContainer == null){
// This line does it ... careful to only call it once!
myContainer = CorePlugin.getBlackBoard().makeChildContainer();
}
}
}
return myContainer;
}
NOTE:
Please check to ensure the child you want is not already created (important for two plugins
sharing one container).
|
| getDefault | | public static CorePlugin getDefault()(Code) | | Returns the system created plugin object
the plugin object |
| isDebugging | | public static boolean isDebugging(String trace)(Code) | | Performs the Platform.getDebugOption true check on the provided trace
Note: ProjectUIPlugin.getDefault().isDebugging() must also be on.
- Trace.RENDER - trace rendering progress
Parameters:
trace - currently only RENDER is defined |
| isDeveloping | | public static boolean isDeveloping()(Code) | | |
| log | | public static void log(String message2, Throwable e)(Code) | | Writes an info log in the plugin's log.
This should be used for user level messages.
|
| start | | public void start(BundleContext context) throws Exception(Code) | |
See Also: org.osgi.framework.BundleActivator.start(org.osgi.framework.BundleContext) |
| stringsToURLs | | public static List<URL> stringsToURLs(String string)(Code) | | Takes a string, and splits it on '\n' and calls stringsToURLs(String[])
|
| stringsToURLs | | public static List<URL> stringsToURLs(String[] strings)(Code) | | Converts each element of an array from a String to a URL. If the String is not a valid URL,
it attempts to load it as a File and then convert it. If that fails, it ignores it. It will
not insert a null into the returning List, so the size of the List may be smaller than the
size of strings
Parameters:
strings - an array of strings, each to be converted to a URL a List of URLs, in the same order as the array |
| trace | | public static void trace(String message, Throwable e)(Code) | | Messages that only engage if getDefault().isDebugging()
It is much prefered to do this:
private static final String RENDERING = "net.refractions.udig.project/render/trace";
if (ProjectUIPlugin.getDefault().isDebugging() && "true".equalsIgnoreCase(RENDERING)) {
System.out.println("your message here");
}
|
|
|