org.uberfire.workbench.type

Interface ResourceTypeDefinition

All Known Implementing Classes:

AnyResourceTypeDefinition, DotResourceTypeDefinition, TextResourceTypeDefinition

@JsType
public interface ResourceTypeDefinition

Definition of a Resource Type

Method Summary

Modifier and Type	Method and Description
boolean	accept(Path path) Indicates if the current parameter path matched the current resource type
Category	getCategory() Defines the category for each resource.
String	getDescription() A description of the resource type
default DiffMode	getDiffMode() Defines how the diff of this resource type should be presented.
String	getPrefix() Resource prefix
int	getPriority() Defines the resource priority in terms of resource resolution
String	getShortName() A short name of the resource type
String	getSimpleWildcardPattern() A simple (and maybe not very accurate) wildcard pattern to search for this type of resource.
String	getSuffix() Resource suffix

Method Detail

getShortName

String getShortName()

A short name of the resource type

Returns:

the short name

getDescription

String getDescription()

A description of the resource type

Returns:

the description

getPrefix

String getPrefix()

Resource prefix

Returns:

the prefix

getSuffix

String getSuffix()

Resource suffix

Returns:

the prefix

getPriority

int getPriority()

Defines the resource priority in terms of resource resolution

Returns:

the priority

getSimpleWildcardPattern

String getSimpleWildcardPattern()

A simple (and maybe not very accurate) wildcard pattern to search for this type of resource. This is only used in order to optimize index and search.

Returns:

the wildcard pattern

accept

boolean accept(Path path)

Indicates if the current parameter path matched the current resource type

Returns:

true if matches, otherwise false

getCategory

Category getCategory()

Defines the category for each resource. If no category is defined, Undefined should be returned

Returns:

the resource category

getDiffMode

default DiffMode getDiffMode()

Defines how the diff of this resource type should be presented.

Returns:

the resource diff mode