---

Overview  Package    Class   Use  Tree  Deprecated  Index  Help		Eclipse JDT Release 3.5
PREV CLASS    NEXT CLASS	NO FRAMES
SUMMARY: NESTED |  FIELD |  CONSTR |  METHOD	DETAIL:  FIELD |  CONSTR |  METHOD

---

org.eclipse.jdt.ui.cleanup
Class CleanUpOptions

java.lang.Object
  
org.eclipse.jdt.ui.cleanup.CleanUpOptions

---

public class CleanUpOptions
extends 
Object

Allows to set and retrieve clean up settings for given options keys.

Since:

3.5

Restriction:

This class is not intended to be subclassed by clients.

---

Field Summary
static  String	FALSE           False value
static  String	TRUE           True value

 

Constructor Summary
	CleanUpOptions ()           Creates a new instance.
protected	CleanUpOptions ( Map options)           Creates a new CleanUpOptions instance with the given options.

 

Method Summary
Set	getKeys ()           Returns an unmodifiable set of all known keys.
String	getValue ( String key)           Returns the value for the given key.
boolean	isEnabled ( String key)           Tells whether the option with the given key is enabled.
void	setOption ( String key, String value)           Sets the option for the given key to the given value.

 

Methods inherited from class java.lang. Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Field Detail

TRUE

public static final 
String TRUE

True value

See Also:

Constant Field Values

---

FALSE

public static final 
String FALSE

False value

See Also:

Constant Field Values

Constructor Detail

CleanUpOptions

protected CleanUpOptions(
Map options)

Creates a new CleanUpOptions instance with the given options.

Parameters:

options - map that maps clean ups keys (String) to a non-null string value

---

CleanUpOptions

public CleanUpOptions()

Creates a new instance.

Method Detail

isEnabled

public boolean isEnabled(
String key)

Tells whether the option with the given key is enabled.

Parameters:

key - the name of the option

Returns:

true if enabled, false if not enabled or unknown key

Throws:

IllegalArgumentException - if the key is null

See Also:

CleanUpConstants

---

getValue

public 
String getValue(
String key)

Returns the value for the given key.

Parameters:

key - the key of the value

Returns:

the value associated with the key

Throws:

IllegalArgumentException - if the key is null or unknown

---

setOption

public void setOption(
String key,
                      
String value)

Sets the option for the given key to the given value.

Parameters:

key - the name of the option to set

value - the value of the option

Throws:

IllegalArgumentException - if the key is null

See Also:

TRUE, FALSE

---

getKeys

public 
Set getKeys()

Returns an unmodifiable set of all known keys.

Returns:

an unmodifiable set of all keys

---

Overview  Package    Class   Use  Tree  Deprecated  Index  Help		Eclipse JDT Release 3.5
PREV CLASS    NEXT CLASS	NO FRAMES
SUMMARY: NESTED |  FIELD |  CONSTR |  METHOD	DETAIL:  FIELD |  CONSTR |  METHOD

---

Copyright (c) IBM Corp. and others 2000, 2008. All Rights Reserved.