org.openide.filesystems 7.32.1 1

org.openide.filesystems.annotations
Class LayerBuilder

java.lang.Object
  extended by org.openide.filesystems.annotations.LayerBuilder

public final class LayerBuilder
extends Object

Convenience class for generating fragments of an XML layer.

Since:
org.openide.filesystems 7.15
See Also:
LayerGeneratingProcessor.layer(javax.lang.model.element.Element...)

Nested Class Summary
 class LayerBuilder.File
          Builder for creating a single file entry.
 
Method Summary
 LayerBuilder.File file(String path)
          Adds a file to the layer.
 LayerBuilder.File folder(String path)
          Adds a folder to the layer.
 LayerBuilder.File instanceFile(String path, String name)
          Generates an instance file that is not initialized with an instance.
 LayerBuilder.File instanceFile(String path, String name, Class type)
          Generates an instance file whose InstanceCookie would load the associated class or method.
 LayerBuilder.File shadowFile(String target, String folder, String name)
          Convenience method to create a shadow file (like a symbolic link).
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

file

public LayerBuilder.File file(String path)
Adds a file to the layer. You need to LayerBuilder.File.write() it in order to finalize the effect.

Parameters:
path - the full path to the desired file in resource format, e.g. "Menu/File/exit.instance"
Returns:
a file builder

folder

public LayerBuilder.File folder(String path)
Adds a folder to the layer. You need to LayerBuilder.File.write() it in order to finalize the effect.

Normally just using file(java.lang.String) suffices, since parent folders are created as needed, but you may use this method if you wish to create a folder (possibly with some attributes) without necessarily creating any children.

Parameters:
path - the full path to the desired folder in resource format, e.g. "Menu/File"
Returns:
a file builder
Since:
org.openide.filesystems 7.26

instanceFile

public LayerBuilder.File instanceFile(String path,
                                      String name,
                                      Class type)
                               throws IllegalArgumentException,
                                      LayerGenerationException
Generates an instance file whose InstanceCookie would load the associated class or method. Useful for LayerGeneratingProcessors which define layer fragments which instantiate Java objects from the annotated code.

While you can pick a specific instance file name, if possible you should pass null for name as using the generated name will help avoid accidental name collisions between annotations.

Parameters:
path - path to folder of instance file, e.g. "Menu/File"
name - instance file basename, e.g. "my-menu-Item", or null to pick a name according to the element
type - a type to which the instance ought to be assignable, or null to skip this check
Returns:
an instance file (call LayerBuilder.File.write() to finalize)
Throws:
IllegalArgumentException - if the builder is not associated with exactly one class or method
LayerGenerationException - if the associated element would not be loadable as an instance of the specified type

instanceFile

public LayerBuilder.File instanceFile(String path,
                                      String name)
                               throws IllegalArgumentException,
                                      LayerGenerationException
Generates an instance file that is not initialized with an instance. Useful for LayerGeneratingProcessors which define layer fragments which indirectly instantiate Java objects from the annotated code via a generic factory method. Invoke the factory using LayerBuilder.File.methodvalue(java.lang.String, java.lang.String, java.lang.String) on instanceCreate and configure it with a LayerBuilder.File.instanceAttribute(java.lang.String, java.lang.Class) appropriate to the factory.

While you can pick a specific instance file name, if possible you should pass null for name as using the generated name will help avoid accidental name collisions between annotations.

Parameters:
path - path to folder of instance file, e.g. "Menu/File"
name - instance file basename, e.g. "my-menu-Item", or null to pick a name according to the element
Returns:
an instance file (call LayerBuilder.File.write() to finalize)
Throws:
IllegalArgumentException - if the builder is not associated with exactly one class or method
LayerGenerationException - if the associated element would not be loadable as an instance
Since:
org.openide.filesystems 7.27

shadowFile

public LayerBuilder.File shadowFile(String target,
                                    String folder,
                                    String name)
Convenience method to create a shadow file (like a symbolic link).

While you can pick a specific shadow file name, if possible you should pass null for name as using the generated name will help avoid accidental name collisions between annotations.

Parameters:
target - the complete path to the original file (use LayerBuilder.File.getPath() if you just made it)
folder - the folder path in which to create the shadow, e.g. "Menu/File"
name - the basename of the shadow file sans extension, e.g. "my-Action", or null to pick a default
Returns:
a shadow file (call LayerBuilder.File.write() to finalize)

org.openide.filesystems 7.32.1 1

Built on February 22 2010.  |  Portions Copyright 1997-2010 Sun Microsystems, Inc. All rights reserved.