Classes BeanInfo e Introspecção

Se você estiver criando novos componentes ou beans para serem utilizados no visual editor (por exemplo, incluindo componentes na paleta), será possível controlar o comportamento deles, fornecendo uma classe BeanInfo.

Uma classe BeanInfo implementa java.beans.BeanInfo e é utilizada pelo visual editor para determinar o comportamento da visualização de propriedades para o bean e se um personalizador está disponível. O visual editor inclui classes BeanInfo para controles AWT e Swing comuns.

Como a classe BeanInfo contém informações requeridas apenas na hora do design, ela é, geralmente, mantida em um projeto diferente da classe do bean em si e não é incluída quando o bean é implementado. O visual editor para Java utiliza várias regras que permitem associar classes BeanInfo aos beans Java que elas descrevem. Será necessário entender essas regras se você estiver utilizando beans Java tendo classes BeanInfo que você deseja que o visual editor detecte. Por exemplo, se você estiver utilizando um conjunto de terceiros de classes Java bean ou se tiver desenvolvido beans Java e classes BeanInfo que está utilizando.

Para aprender mais sobre as classes BeanInfo, você pode fazer download da especificação JavaBeans a partir de java.sun.com/products/javabeans/docs/.

Segundo Plano

A classe java.beans.Introspector é utilizada para localizar uma classe BeanInfo para um Java bean. A hora em que isso ocorre é mencionada como introspecção e é feita pelo visual editor na primeira vez que um bean é utilizado. Por exemplo, quando um botão é solto pela primeira vez da paleta, ocorre uma introspecção que tenta localizar a classe BeanInfo correta. Depois da introspecção do bean, os resultados são armazenados em cache para ajudar no desempenho. Porém, quando o visual editor detecta que a classe BeanInfo pode ter sido alterada e o cache é stale, a introspecção ocorrerá novamente.

A introspecção de um bean é feita chamando o método estático getBeanInfo(Class) com a classe bean como o argumento. Exemplo:

java.beans.Introspector.getBeanInfo(MyJavaBean.class)

O introspector utiliza testes para localizar uma classe BeanInfo para a classe de argumento MyJavaBean. Se qualquer teste obtiver êxito, o introspector pára de procurar. Se uma etapa falhar, o introspector tenta o próximo teste para localizar a classe BeanInfo. O introspector utiliza os seguintes testes lógicos:

Se o próprio Java bean implementar java.beans.BeanInfo, o bean será utilizado como a classe BeanInfo. Porém, esse cenário raramente ocorre porque significa que a classe de tempo de execução MyJavaBean contém informações de tempo do design que serão desnecessariamente incluídas na implementação.
Se existir uma classe com o mesmo nome da classe do argumento mais a cadeia BeanInfo anexada ao nome (por exemplo, MyJavaBeanBeanInfo), essa classe será utilizada como a classe BeanInfo. Ela é procurada primeiro no mesmo pacote que a classe e se não for encontrada, será localizada dentro de um caminho da procura definido. Em vez de utilizar o caminho de classe da máquina virtual Java para procurar a classe BeanInfo, o introspector tem sua própria lista de pacotes onde procurar. Isso é conhecido como o caminho da procura de BeanInfo. O introspector não utiliza o caminho de classe novamente para manter separadas as informações de tempo do tempo de execução e do design.
Se nenhuma classe BeanInfo for localizada para a classe imediata cuja introspecção está sendo realizada, o introspector tentará localizar a classe BeanInfo para a superclasse.
Se nenhuma classe BeanInfo for localizada para a classe imediata cuja introspecção está sendo realizada, uma classe padrão será criada. O padrão tomará os resultados da introspecção da superclasse imediata e mesclará nos resultados das propriedades padrão da classe imediata. As regras para criar as propriedades padrão são para corresponder os métodos obtido e definido com nomes e argumentos compatíveis. Por exemplo, os métodos public void setName(String aName) e public String getName() são unidos em uma propriedade chamada name. O BeanInfo criado não é armazenado como uma classe em nenhum pacote. É uma instância transitória que é utilizada como uma descrição temporária dos detalhes de tempo de design do bean, de forma que o visual editor possa extrair uma lista de propriedades e outras informações.

Se uma classe BeanInfo for localizada para a classe, o introspector não a retornará explicitamente. Em vez disso, ele utiliza seus detalhes para criar uma classe de resultados temporários que implementa java.beans.BeanInfo.

Caminho da Procura de BeanInfo

A melhor maneira de entender o caminho de BeanInfo é considerar a máquina virtual Java que é criada para executar a introspecção. Essa máquina virtual recebe um caminho de classe que é formado pelas seguintes entradas:

Os itens no caminho de construção Java para o projeto em si
Os itens nas classes BeanInfo no caminho de BeanInfo para o projeto em si
Todos os itens exportados nas classes BeanInfo para todos os projetos no caminho de construção Java

Tendo criado a máquina virtual, o java.beans.Introspector tem sua lista de pacotes para procurar classes BeanInfo definidas com o método public void setSearchPath(String[]).

Os argumentos para esse método são:

Os itens na lista de pacotes no caminho de BeanInfo para o projeto em si
Todos os itens exportados nas listas de pacotes para todos os projetos no caminho de construção Java

BeanInfo e Atributos Próprios

Se o bean que você está gravando estiver herdando atributos de uma superclasse, o BeanInfo padrão não exporá os atributos próprios. Será necessário expô-los explicitamente com o método getAdditionalBeanInfo().

Exemplo:

public BeanInfo[] getAdditionalBeanInfo() { 
try {                 
         // The following will return all inherited features.                 
         return new BeanInfo[] { 
Introspector.getBeanInfo(MyPanel.class.getSuperclass())};  
} catch (IntrospectionException e) {            
return new BeanInfo[0];            
}

Se um atributo próprio não for exposto, o visual editor não irá apresentá-lo, mesmo que ele seja definido no código fonte.