Package blackboard.base

Provides common classes and utility classes used throughout the platform API.

See:
          Description

Class Summary
AppVersion The AppVersion class provides a means of describing (indicating) the properties of an object to be loaded/persisted by the persistence framework.
BaseComparator Base comparator class that implements ascending/descending and chaining.
BbDeleteTrackingList An extension of BbList that maintains a tracking set of elements that have been removed through one mechanism or another.
BbEnum Base enumeration class for fixed enumerations.
BbLabeledEnum Base enumeration class for enumerations that are used to supply UI-visible labels.
BbList Generic list class for a collection of objects.
FilteringIterator The FilteringIterator class provides a means of applying a set of "filters" to an iterator.
FormattedText The FormattedText class provides a means for storing a piece of text along with a companion formatting specification.
FormattedText.Type Enumeration class to specify possible text formats.
GenericFieldComparator Comparator implementation that allows objects in a list to be compared based on the value of an attribute that they have in common.
GenericFieldFilter Filter implementation that allows objects in a list to be filtered based on the value of an attribute that they have in common.
GenericFieldFilter.Comparison  
ListFilter Filters are used to get a sublist from a list using arbitrary, consumer defined, selection criteria.
NullIterator A "null" implementation of the Iterator interface.
SharableArrayList This class will eventually be a copy of array list to provide for ultra shallow cloning and copy-on-modify.
 

Exception Summary
InitializationException Exceptions thrown at application initialization time.
NestedException Base exception class for application specific exceptions that wish to hide the underlying exceptions.
NestedRuntimeException Base exception class for application specific exceptions that wish to hide the underlying exceptions.
 

Package blackboard.base Description

Provides common classes and utility classes used throughout the platform API. Of note are the classes that provide the foundation exception classes and type-safe enumeration support.

Enumerations

All type-safe, enumeration-style inner classes (e.g., User.Gender derive from the BbEnum class.

Exceptions

There are two exceptions defined in this package: InitializationException and NestedException (and NestedRuntimException). The nested exceptions were introduced prior to JDK 1.4 to emulate exception chaining (i.e., allow root cause exceptions to propagate up the stack). These may change in future releases, so developers catching these explicitly should probably re-evaluate which exceptions to catch.



Copyright © 2003 Blackboard, Inc. All Rights Reserved.