com.ibm.wsspi.anno.info

Interface InfoStore


  1. public interface InfoStore

A store of info objects (packages, classes, fields, methods, and annotations).


Method Summary

Modifier and Type Method and Description
  1. void
close()
  1. ClassSource_Aggregate
getClassSource()
  1. ClassInfo
getDelayableClassInfo(java.lang.String name)
Answer (possibly delayed) class info object for a specified class name.
  1. java.lang.String
getHashText()
Answer a print string for the receiver, for use in debugging.
  1. InfoStoreFactory
getInfoStoreFactory()
  1. PackageInfo
getPackageInfo(java.lang.String name)
Answer the package info object for a specified package name.
  1. long
getRuleTime()
Answer the total time, in milliseconds, spent doing rule processing.
  1. long
getScanTime()
Answer the total time, in milliseconds, spent scanning classes.
  1. long
getStreamCount()
Answer the number of entries to stream processing.
  1. long
getStreamTime()
Answer the total time, in milliseconds, doing stream processing.
  1. java.lang.String
internClassName(java.lang.String className)
Answer the interned copy of a specified class name.
  1. java.lang.String
internDescription(java.lang.String description)
Answer the interned copy of a specified description.
  1. java.lang.String
internPackageName(java.lang.String packageName)
Answer the interned copy of a specified package name.
  1. void
log(TraceComponent logger)
Log the receiver to the specified logger.
  1. void
open()

Method Detail

getHashText

  1. java.lang.String getHashText()

Answer a print string for the receiver, for use in debugging. The value is guaranteed to be unique during the lifetime of the receiver, and, for frequently created types, will be created on demand.

Returns:
A print string for the receiver.

log

  1. void log(TraceComponent logger)

Log the receiver to the specified logger.

Parameters:
logger - The logger to receive the display of the receiver.

getInfoStoreFactory

  1. InfoStoreFactory getInfoStoreFactory( )

getClassSource

  1. ClassSource_Aggregate getClassSource( )

open

  1. void open()
  2. throws InfoStoreException
Throws:

close

  1. void close()
  2. throws InfoStoreException
Throws:

internDescription

  1. java.lang.String internDescription( java.lang.String description)

Answer the interned copy of a specified description.

Parameters:
description - The string description value which is to be interned.
Returns:
The interned copy of a specified string.
See Also:
internPackageName(String), internClassName(String), #internQualifiedFieldName(String), #internQualifiedMethodName(String)

internPackageName

  1. java.lang.String internPackageName( java.lang.String packageName)

Answer the interned copy of a specified package name.

Parameters:
packageName - The package name which is to be interned.
Returns:
The interned copy of the package name.
See Also:
internDescription(String), internClassName(String), #internQualifiedFieldName(String), #internQualifiedMethodName(String)

internClassName

  1. java.lang.String internClassName( java.lang.String className)

Answer the interned copy of a specified class name.

Each store has a string store used to guarantee unique of string values. Maintenance of a string store is necessary because the process of loading class and annotations information does not guarantee identical instances for strings which have the same value, and because collections of related classes tend to produce many of the same string values. For example, the reference of a class to a super type, or to an interface, uses the same string value as the declaration of the super type, or of the interface.

Interning string values leads to dramatically smaller overall string allocations.

Parameters:
className - The string class name which is to be interned.
Returns:
The interned copy of the class name.
See Also:
internDescription(String), #internQualifiedFieldName(String), #internQualifiedMethodName(String)

getPackageInfo

  1. PackageInfo getPackageInfo(java.lang.String name)

Answer the package info object for a specified package name.

Returns:
The package info object for a specified package name. TODO What happens if the package is not found?

getDelayableClassInfo

  1. ClassInfo getDelayableClassInfo( java.lang.String name)

Answer (possibly delayed) class info object for a specified class name.

Returns:
The class info object for a specified class name.

getStreamCount

  1. long getStreamCount()

Answer the number of entries to stream processing.

Returns:
The number of entries to stream processing.

getStreamTime

  1. long getStreamTime()

Answer the total time, in milliseconds, doing stream processing.

Returns:
The total time, in milliseconds, doing stream processing.
See Also:

getScanTime

  1. long getScanTime()

Answer the total time, in milliseconds, spent scanning classes.

Returns:
The total time, in milliseconds, spent scanning classes.
See Also:

getRuleTime

  1. long getRuleTime()

Answer the total time, in milliseconds, spent doing rule processing.

Returns:
The total time, in milliseconds, spent doing rule processing.
See Also: