csbase.client.preferences

Class PreferenceCategory

java.lang.Object

csbase.client.preferences.PreferenceCategory

public class PreferenceCategory
extends java.lang.Object

Classe que disponibiliza a API que permite consultarmos as preferências do usuário. A árvore de preferências do usuário, como o próprio nome já diz, é uma estrutura recursiva, onde cada nó é uma instância de PreferenceCategory. Um objeto PreferenceCategory é apenas um agrupador de preferências. Logo, este armazena um conjunto de preferências e também possui categorias filhas. Podemos consultar o valor de uma preferência da seguinte forma: PreferenceManager pm = PreferenceManager.getInstance(); PreferenceCategory root = pm.loadPreferences(); PreferenceCategory desktopCategory = root.getCategory(DesktopPref.class); boolean value = desktopCategory.getPreferenceAsBoolean(DesktopPref.SHOW_HIDDEN_FILES); O código abaixo mostra como consultamos as preferências dentro da classe da aplicação: PreferenceCategory appPref = getPreferences(); String value = appPref.getPreferenceAsString(NotepadPref.FONT); Cada categoria está associada a uma enumeração que a define. Nesta enumeração, cada constante define uma preferência. Para mais informações de como definir preferências através de enumerações, veja a interface PreferenceDefinition.

Author:

Tecgraf

See Also:

PreferenceValue

Method Summary

Modifier and Type	Method and Description
PreferenceCategory	copy() Retorna uma cópia desta categoria.
boolean	equals(java.lang.Object obj) Intâncias dessa classe só podem ser criadas pelo PreferenceManager, logo, as implementações de equals(Object), hashCode() e toString() são muito simples e devem levar em conta apenas se a instância for o mesma.
java.util.List<PreferenceCategory>	getCategories() Retorna a lista com todas as categorias filhas deste nó.
PreferenceCategory	getCategory(java.lang.Class<? extends PreferenceDefinition> enumClass) Retorna a categoria associada a classe da enumeração que a define.
java.lang.String	getId() Identificador da categoria.
java.lang.String	getLabel() Rótulo da categoria.
PreferenceCategory	getOriginal() Referência para categoria original quando esta instância é uma cópia.
PreferenceValue<?>	getPreference(PreferenceDefinition name) Retorna o valor da preferência.
java.lang.Boolean	getPreferenceAsBoolean(PreferenceDefinition name) Retorna o valor da preferência como Boolean.
java.lang.Integer	getPreferenceAsInt(PreferenceDefinition name) Retorna o valor da preferência como Integer.
java.lang.String	getPreferenceAsString(PreferenceDefinition name) Retorna o valor da preferência como String.
java.util.List<PreferenceValue<?>>	getPreferences(PreferencePolicy... policies) Retorna lista com os valores de preferências que atendem as políticas de visibilidade.
PVBoolean	getPVBoolean(PreferenceDefinition name) Retorna o objeto que encapsula um valor de preferência boleano correspondente a constante dada.
PVInteger	getPVInteger(PreferenceDefinition name) Retorna o objeto que encapsula um valor de preferência que é do tipo Integer correspondente a constante dada.
PVString	getPVString(PreferenceDefinition name) Retorna o objeto que encapsula um valor de preferência que é do tipo String correspondente a constante dada.
int	hashCode() Intâncias dessa classe só podem ser criadas pelo PreferenceManager, logo, as implementações de equals(Object), hashCode() e toString() são muito simples e devem levar em conta apenas se a instância for o mesma.
boolean	hasPreference(PreferenceDefinition name) Verifica se existe a preferência com o dado nome.
boolean	hasPreferences(PreferencePolicy... policies) Retorna true se há pelo menos uma preferência com uma das políticas de visibilidade passadas por parâmetro, false caso contrário.
boolean	isCopy() Retorna true se esta categoria for uma cópia, false caso contrário.
boolean	isRoot() True se está categoria for raíz da árvore de preferências, false caso contrário.
java.lang.String	toString() Intâncias dessa classe só podem ser criadas pelo PreferenceManager, logo, as implementações de equals(Object), hashCode() e toString() são muito simples e devem levar em conta apenas se a instância for o mesma.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getId

public java.lang.String getId()

Identificador da categoria.

Returns:

identificador da categoria.

isRoot

public boolean isRoot()

True se está categoria for raíz da árvore de preferências, false caso contrário.

Returns:

true se está categoria for raíz da árvore de preferências, false caso contrário.

isCopy

public boolean isCopy()

Retorna true se esta categoria for uma cópia, false caso contrário.

Returns:

retorna true se esta categoria for uma cópia, false caso contrário.

getOriginal

public PreferenceCategory getOriginal()

Referência para categoria original quando esta instância é uma cópia.

Returns:

referência para categoria original quando esta instância é uma cópia.

getLabel

public java.lang.String getLabel()

Rótulo da categoria.

Returns:

rótulo da categoria.

getCategory

public PreferenceCategory getCategory(java.lang.Class<? extends PreferenceDefinition> enumClass)

Retorna a categoria associada a classe da enumeração que a define. Caso não hajá uma categoria associada a enumeração, uma exceção, do tipo PreferenceException é lançada.

Parameters:

enumClass - classe da enumeração que encapsula as preferências.

Returns:

categoria equivalente.

getCategories

public java.util.List<PreferenceCategory> getCategories()

Retorna a lista com todas as categorias filhas deste nó.

Returns:

lista com todas as categorias filhas.

hasPreference

public boolean hasPreference(PreferenceDefinition name)

Verifica se existe a preferência com o dado nome.

Parameters:

name - constante que define a preferência.

Returns:

true se existir uma preferência com o dado nome, false caso contrário.

getPreference

public PreferenceValue<?> getPreference(PreferenceDefinition name)

Retorna o valor da preferência.

Parameters:

name - constante que define a preferência.

Returns:

valor da preferência.

getPVString

public PVString getPVString(PreferenceDefinition name)

Retorna o objeto que encapsula um valor de preferência que é do tipo String correspondente a constante dada.

Parameters:

name - constante que define a preferência.

Returns:

valor de preferência String.

getPVBoolean

public PVBoolean getPVBoolean(PreferenceDefinition name)

Retorna o objeto que encapsula um valor de preferência boleano correspondente a constante dada.

Parameters:

name - constante que define a preferência.

Returns:

valor de preferência boleano.

getPVInteger

public PVInteger getPVInteger(PreferenceDefinition name)

Retorna o objeto que encapsula um valor de preferência que é do tipo Integer correspondente a constante dada.

Parameters:

name - constante que define a preferência.

Returns:

valor de preferência Integer.

getPreferenceAsString

public java.lang.String getPreferenceAsString(PreferenceDefinition name)

Retorna o valor da preferência como String. Para isso, o valor da preferência deve ser uma instância de PVString, caso contrário será lançado uma exceção do tipo PreferenceException.

Parameters:

name - constante que define a preferência.

Returns:

valor em string.

getPreferenceAsBoolean

public java.lang.Boolean getPreferenceAsBoolean(PreferenceDefinition name)

Retorna o valor da preferência como Boolean. Para isso, o valor da preferência deve ser uma instância de PVBoolean, caso contrário será lançado uma exceção do tipo PreferenceException.

Parameters:

name - constante que define a preferência.

Returns:

valor booleano.

getPreferenceAsInt

public java.lang.Integer getPreferenceAsInt(PreferenceDefinition name)

Retorna o valor da preferência como Integer. Para isso, o valor da preferência deve ser uma instância de PVInteger, caso contrário será lançado uma exceção do tipo PreferenceException.

Parameters:

name - constante que define a preferência.

Returns:

valor inteiro.

getPreferences

public java.util.List<PreferenceValue<?>> getPreferences(PreferencePolicy... policies)

Retorna lista com os valores de preferências que atendem as políticas de visibilidade.

Parameters:

policies - array com as políticas de visibilidade.

Returns:

lista com todos os valores de preferências.

hasPreferences

public boolean hasPreferences(PreferencePolicy... policies)

Retorna true se há pelo menos uma preferência com uma das políticas de visibilidade passadas por parâmetro, false caso contrário.

Parameters:

policies - array com as políticas de visibilidade.

Returns:

true se há pelo menos uma preferência visível, false caso contrário.

copy

public PreferenceCategory copy()

Retorna uma cópia desta categoria. A cópia de uma categoria contém cópias de todos os valores de preferências. Nota: os ouvintes dos valores de preferências não são copiados.

Returns:

objeto que representa a cópia desta categoria.

equals

public boolean equals(java.lang.Object obj)

Intâncias dessa classe só podem ser criadas pelo PreferenceManager, logo, as implementações de equals(Object), hashCode() e toString() são muito simples e devem levar em conta apenas se a instância for o mesma. Sobrescrito apenas para fins de documentação.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Intâncias dessa classe só podem ser criadas pelo PreferenceManager, logo, as implementações de equals(Object), hashCode() e toString() são muito simples e devem levar em conta apenas se a instância for o mesma. Sobrescrito apenas para fins de documentação.

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Intâncias dessa classe só podem ser criadas pelo PreferenceManager, logo, as implementações de equals(Object), hashCode() e toString() são muito simples e devem levar em conta apenas se a instância for o mesma. Sobrescrito apenas para fins de documentação.

Overrides:

toString in class java.lang.Object