org.eclipse.wst.common.snippets.core
Interface ISnippetsEntry

All Known Subinterfaces:

ISnippetCategory, ISnippetItem

public interface ISnippetsEntry

A Snippets Entry is an abstract notion encapsulating the values used to represent Snippet Items and Containers. No object implements only this interface.

Since:

1.0

Field Summary

static java.lang.String	SNIPPET_SOURCE_PLUGINS Denotes that this entry was contributed by a plug-in
static java.lang.String	SNIPPET_SOURCE_USER Denotes that this entry was created by the user
static java.lang.String	SNIPPET_SOURCE_WORKSPACE Denotes that this entry was discovered within the workspace

Method Summary

java.lang.String	getDescription()
java.lang.String[]	getFilters()
java.lang.String	getLabel()
java.lang.Object	getSourceDescriptor()
java.lang.Object	getSourceType()

Field Detail

SNIPPET_SOURCE_PLUGINS

public static final java.lang.String SNIPPET_SOURCE_PLUGINS

Denotes that this entry was contributed by a plug-in

See Also:

Constant Field Values

SNIPPET_SOURCE_USER

public static final java.lang.String SNIPPET_SOURCE_USER

Denotes that this entry was created by the user

See Also:

Constant Field Values

SNIPPET_SOURCE_WORKSPACE

public static final java.lang.String SNIPPET_SOURCE_WORKSPACE

Denotes that this entry was discovered within the workspace

See Also:

Constant Field Values

Method Detail

getDescription

public java.lang.String getDescription()

Returns:

a longer description to display for this item

getFilters

public java.lang.String[] getFilters()

Returns:

the filters for which this entry will be shown when filtering is enabled

getLabel

public java.lang.String getLabel()

Returns:

the label to display for this item

getSourceDescriptor

public java.lang.Object getSourceDescriptor()

Returns:

the object defining where this entry originated from. Valid values are instances of CategoryFileInfo and PluginRecord.

getSourceType

public java.lang.Object getSourceType()

Returns:

the type of the source descriptor. Valid values are SNIPPET_SOURCE_PLUGINS, SNIPPET_SOURCE_USER, and SNIPPET_SOURCE_WORKSPACE.