oracle.jdeveloper.model

Interface SourceRootHelper

public interface SourceRootHelper

The SourceRootHelper defines the protocol by which a class can participate in determining the source root for files of a specific, non-Java file type.

Method Summary

Modifier and Type	Method and Description
java.net.URL	determineSourceRoot(Node node, boolean[] errorStatus) Gets the URL for the source root associated with the supplied node.
java.lang.String	getFileExtension() Gets the file-name suffix for the file type that is handled by this helper.
java.lang.Class	getNodeClass() Gets the Class of the node type that is handled by this helper.

Method Detail

getFileExtension

java.lang.String getFileExtension()

Gets the file-name suffix for the file type that is handled by this helper. This value should include the dot (.) and should not be null. .jspx and .xml, for example, are acceptable extensions.

Note: The file extension should represent a non-Java file type.

Returns:

the file extension

getNodeClass

java.lang.Class getNodeClass()

Gets the Class of the node type that is handled by this helper.

Note: The class type must represent a non-Java file type, thus it should not be JavaSourceNode.

Returns:

The Class of the node type

determineSourceRoot

java.net.URL determineSourceRoot(Node node,
                                 boolean[] errorStatus)

Gets the URL for the source root associated with the supplied node.

Parameters:

node - A node of the type specified by getNodeClass()

errorStatus - Holds the error state for this method. If the URL that is being returned was not determined to be a valid source root, errorStatus[0] should be set to true.

Returns:

returns a directory URL

See Also:

getNodeClass()