com.vaadin.server.widgetsetutils

Class ClassPathExplorer

java.lang.Object

com.vaadin.server.widgetsetutils.ClassPathExplorer

public class ClassPathExplorer
extends Object

Utility class to collect widgetset related information from classpath. Utility will seek all directories from classpaths, and jar files having "Vaadin-Widgetsets" key in their manifest file.

Used by WidgetMapGenerator and ide tools to implement some monkey coding for you.

Developer notice: If you end up reading this comment, I guess you have faced a sluggish performance of widget compilation or unreliable detection of components in your classpaths. The thing you might be able to do is to use annotation processing tool like apt to generate the needed information. Then either use that information in WidgetMapGenerator or create the appropriate monkey code for gwt directly in annotation processor and get rid of WidgetMapGenerator. Using annotation processor might be a good idea when dropping Java 1.5 support (integrated to javac in 6).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClassPathExplorer.LocationInfo Contains information about widgetsets and themes found on the classpath.

Method Summary

Modifier and Type	Method and Description
static Map<String,URL>	getAvailableWidgetSets() Deprecated. Use getAvailableWidgetSetsAndStylesheets() instead
static ClassPathExplorer.LocationInfo	getAvailableWidgetSetsAndStylesheets() Finds the names and locations of widgetsets and themes available on the class path.
static URL	getDefaultSourceDirectory() Find and return the default source directory where to create new widgetsets.
static URL	getWidgetsetSourceDirectory(String widgetsetFileName) Find and return the source directory which contains the given widgetset file.
static void	main(String[] args) Test method for helper tool.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getAvailableWidgetSets

@Deprecated
public static Map<String,URL> getAvailableWidgetSets()

Deprecated. Use getAvailableWidgetSetsAndStylesheets() instead

Finds the names and locations of widgetsets available on the class path.

Returns:

map from widgetset classname to widgetset location URL

getAvailableWidgetSetsAndStylesheets

public static ClassPathExplorer.LocationInfo getAvailableWidgetSetsAndStylesheets()

Finds the names and locations of widgetsets and themes available on the class path.

Returns:

getDefaultSourceDirectory

public static URL getDefaultSourceDirectory()

Find and return the default source directory where to create new widgetsets. Return the first directory (not a JAR file etc.) on the classpath by default. TODO this could be done better...

Returns:

URL

getWidgetsetSourceDirectory

public static URL getWidgetsetSourceDirectory(String widgetsetFileName)

Find and return the source directory which contains the given widgetset file. If not applicable or widgetsetFileName is null, return the first directory (not a JAR file etc.) on the classpath. TODO this could be done better...

Parameters:

widgetsetFileName - relative path for the widgetset

Returns:

URL

Since:

7.6.5

main

public static void main(String[] args)

Test method for helper tool.