oracle.ide.config

Class GlobalIgnoreList

java.lang.Object

oracle.javatools.data.HashStructureAdapter

oracle.ide.config.ChangeEventSource

oracle.ide.config.GlobalIgnoreList

All Implemented Interfaces:

Copyable

public class GlobalIgnoreList
extends ChangeEventSource
implements Copyable

This class stores the IDE Global Ignore list. This is a list of filters that can be used to exclude files or directories from projects. It extends ChangeEventSource to provide ChangeListener support.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	KEY_SETTINGS

Fields inherited from class oracle.javatools.data.HashStructureAdapter

_hash

Constructor Summary

Constructors

Constructor and Description
GlobalIgnoreList()

Method Summary

Modifier and Type	Method and Description
java.lang.Object	copyTo(java.lang.Object target) Copys the data to the target
static java.util.List	createDefaults() Creates a list of Pair objects where each Pair is made up of a String that represents the text for the exclude filter and a Boolean to indicate whether the filter is enabled or not.
java.util.List	getList() Gets the list of Pairs used to represent each filter in the list.
static PatternFilters	getPatternFilters() Gets the PatternFilters object that represents all the enabled exclude filters that are part of the global ignore list.
static URLFilter	getURLFilter() Returns a URLFilter instance whose behavior is backed by the GlobalIgnoreList's PatternFilters.
static boolean	isExtensionRegisteredFilter(java.lang.String excludeString) Used to determine if the specified exclude string is one that is provided by an extension.
static boolean	isGloballyIgnored(java.net.URL url) Determines whether the specified URL is globally ignored.
static void	registerExcludeFilter(java.lang.String excludeString) Addins can register strings that should be added to the global ignore list These strings will be used to create an exclude filter and will be persisted across JDeveloper sessions.
void	setList(java.util.List list) Sets the list of Pairs used to represent each filter in the list.

Methods inherited from class oracle.ide.config.ChangeEventSource

addChangeListener, fireChangeEvent, fireChangeEvent, removeChangeListener, setUseObjectEquals

Methods inherited from class oracle.javatools.data.HashStructureAdapter

addStructureChangeListener, containsKey, copyToImpl, equals, equalsImpl, findOrCreate, forcedCopyTo, getHashStructure, removeStructureChangeListener, useObjectEquals

Methods inherited from class java.lang.Object

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

Field Detail

KEY_SETTINGS

public static final java.lang.String KEY_SETTINGS

See Also:

Constant Field Values

Constructor Detail

GlobalIgnoreList

public GlobalIgnoreList()

Method Detail

isGloballyIgnored

public static final boolean isGloballyIgnored(java.net.URL url)

Determines whether the specified URL is globally ignored.

Parameters:

url - a url to test.

Returns:

true if the url is globally ignored.

Since:

11.0

registerExcludeFilter

public static void registerExcludeFilter(java.lang.String excludeString)

Addins can register strings that should be added to the global ignore list These strings will be used to create an exclude filter and will be persisted across JDeveloper sessions. The string will not be added to the list if it already exists in the list.

Parameters:

excludeString -

isExtensionRegisteredFilter

public static boolean isExtensionRegisteredFilter(java.lang.String excludeString)

Used to determine if the specified exclude string is one that is provided by an extension. Should only be used by the GlobalIgnoreListPanel.

Parameters:

excludeString -

Returns:

true if the exclude string is provided by an extension, false otherwise

getPatternFilters

public static PatternFilters getPatternFilters()
                                        throws TransientMarker

Gets the PatternFilters object that represents all the enabled exclude filters that are part of the global ignore list. The PatternFilters object returned is not "live", that is, it is created just for the caller and changes to it will not affect the GlobalIgnoreList

Returns:

the pattern filter

Throws:

TransientMarker

getURLFilter

public static URLFilter getURLFilter()

Returns a URLFilter instance whose behavior is backed by the GlobalIgnoreList's PatternFilters. This is a convenient way to get a URLFilter to use with URLFileSystem.list(..) or ls(..).

Returns:

A URLFilter backed by the GlobalIgnoreList PatternFilters.

getList

public java.util.List getList()

Gets the list of Pairs used to represent each filter in the list. Each Pair is made up of a string that represents the exclude string used to create a PatternFilter and a Boolean that represents whether the filter should be enabled or not.

This method should only be used by Object2Dom for persistence or by the GlobalIgnoreListPanel

setList

public void setList(java.util.List list)

Sets the list of Pairs used to represent each filter in the list. Each Pair is made up of a string that represents the exclude string used to create a PatternFilter and a Boolean that represents whether the filter should be enabled or not.

This method should only be used by Object2Dom for persistence or by the GlobalIgnoreListPanel

copyTo

public java.lang.Object copyTo(java.lang.Object target)

Copys the data to the target

Specified by:

copyTo in interface Copyable

Overrides:

copyTo in class ChangeEventSource

Parameters:

target - where to copy the data to. May be null

Returns:

the object the data was copied into

createDefaults

public static java.util.List createDefaults()

Creates a list of Pair objects where each Pair is made up of a String that represents the text for the exclude filter and a Boolean to indicate whether the filter is enabled or not.

The list is built up of strings from the ide.properties file and any strings registered by addins

Returns:

list of Pairs (see above)