info.aduna.gee.spectacle.webserver
Class Channel

java.lang.Object
  info.aduna.gee.spectacle.webserver.Channel

All Implemented Interfaces:

EntryConstants, FileNames, ApiConstants, UserTypes

Direct Known Subclasses:

NavigationChannel, TemplateChannel

public class Channel
extends Object
implements ApiConstants, EntryConstants, FileNames, UserTypes

Class Channel provides a Java API to a channel on the a12r publication server. This API makes it possible to programmatically perform virtually all actions that are normally available through the web-based end-user GUI environment. Note that all changes are made in local memory only, until sync() is called.

Field Summary

static int	PRIVACY_BEST_FRIEND The privacy level 'Best friend'
static int	PRIVACY_CLOSE_FRIEND The privacy level 'Close friend'
static int	PRIVACY_FRIEND The privacy level 'Friend'
static int	PRIVACY_OWNER The privacy level 'Owner'
static int	PRIVACY_WORLD The privacy level 'World'
static String	SORT_BY_LABELS Sort by increasing label identifiers
static String	SORT_BY_TEXT Sort by the visible text of objects
static String	SORT_BY_TYPES Sort by the object types
static int	SUBSCRIPTION_LABEL_ID The id of the synthetic label that is automatically added to information that comes from a subscription to this channel.

Fields inherited from interface info.aduna.gee.publication.servlets.ApiConstants

CREATE_EMAIL_KEY, CREATE_NAME_KEY, CREATE_PASSWORD_KEY, CREATE_TIMETOLIVE_KEY, MESSAGE_KEY, RESULT_KEY, RETURN_CODE_KEY

Fields inherited from interface info.aduna.gee.publication.content.EntryConstants

ACLS_PREFIX, AFTER_TRANSFER, APPLET_TYPE_VALUE, ASSOCIATES_EDIT_LEVEL, BEFORE_STORAGE, BEFORE_TRANSFER, CODE_KEY, CODEBASE_KEY, CONSTRUCTION_KEY, CONTAINER_TTL_KEY, CONTAINERID_KEY, CONTAINERPROPS_KEY, DBPRIVACY_LEVEL_KEY, DESCRIPTION_KEY, EMBED_TYPE_VALUE, END_TIME_KEY, ENTRY_ID_KEY, ENTRYATTRIBS_KEY, ENTRYPARAMS_KEY, ENTRYPROPS_KEY, EXPIRES_KEY, EXTERNAL_ENTRY_KEY, HEIGHT_KEY, HTML_KEY, HTML_TYPE_VALUE, ID2IDID_KEY, IMAGE_TYPE_VALUE, IMPORT_CLASSNAME, IMPORT_DONT_FORWARD, IMPORT_IMPORTED, IMPORT_LANGUAGE, IMPORT_SERVER_NAME, IMPORT_TYPE_VALUE, INFO_EXTENSION, INHERIT_CONFIGURATION, INLINE_DESCRIPTION_IS_HTML_KEY, INLINE_DESCRIPTION_KEY, INSPIRES_KEY, JIT_DESTINATION, JIT_DESTINATION_INDEX, LINK_IN_FRAME_KEY, LINK_KEY, MANUAL_KEY, MINIMALHEIGHT_KEY, MINIMALWIDTH_KEY, NAVIGATION_KEY, OBJECT_TYPE_VALUE, OCCURRING_CLABELS_KEY, OVERRIDE_SUGGESTION_KEY, PRIVACY_LEVEL_KEY, PROVIDE_KEY, PROVIDE_PL_KEY, QUALIFIED_BASE_KEY, RE_EXPORT_KEY, RE_MANUAL_KEY, REPEAT_ID_KEY, REPEAT_TODAY_KEY, REQUIRES_NEW_PAGE, ROTATABLE_KEY, SHARED_CLABELS_KEY, SHOP_GIF_KEY, SHOP_GIF_LOCATION_KEY, SHOP_ID_KEY, SHOP_ORIGIN_KEY, SHOP_OVER_GIF_KEY, SORT_CLABELS, SORT_DESCRIPTION, SOURCE_KEY, STARTSECTION_KEY, SUBSCRIBED_COLOR_KEY, SUBSCRIBED_GIF_KEY, SUBSCRIBED_GIF_LOCATION_KEY, SUBSCRIBED_OVER_GIF_KEY, SUBSCRIBED_VISIBLE_CLABELS_KEY, SUBSCRIPTION_KEY, SUBSCRIPTION_LINK_KEY, SUGGESTION_KEY, SUMMARY_IS_HTML_KEY, SUMMARY_KEY, SUMMARY_TYPE_VALUE, TEMPLATEPREFERENCES_KEY, TEXT_KEY, TEXT_TYPE_VALUE, TIME_KEY, TMPL_DESCRIPTOR_KEY, TMPL_FOREIGN_ID_KEY, TMPL_ID_KEY, TMPL_PREFERENCES_KEY, TMPL_STUB_RECOGNIZER_KEY, TMPLD_TYPE_VALUE, TYPE_KEY, WIDTH_KEY

Fields inherited from interface info.aduna.gee.publication.net.FileNames

ASA_FILE_NAME, BAK_FILE_NAME, CAT_FILE_NAME, CFG_FILE_NAME, CHS_FILE_NAME, DAT_FILE_NAME, HLP_FILE_NAME, LOCAL_FILE_PREFIX, SBS_FILE_NAME, SSS_FILE_NAME, WIF_FILE_NAME

Fields inherited from interface info.aduna.gee.publication.UserTypes

API_BIT, COVER_BUILDER_BIT, ENGINE_BIT, GUEST_BITS, OWNER_BITS, PRO_BITS, PROUSER_BIT, SERVER_BIT, SHOP_BIT, SHOW_BIT, SHOW_BITS, VISITOR_BIT

Constructor Summary

Channel(String server, String name)
Construct a new Channel for the channel with the specified name on the specified server.

Channel(String server, String name, String loginName, String password)
Construct a new Channel for the channel with the specified name on the specified server and login with the specified loginName (optional) and password as login credentials.

Method Summary

void	add(String source, Properties options, Properties attribs, Properties params) Add a content entry to the channel.
void	addSection(PathString dst)
void	addSection(String dst) Ensure the existence of a Section.
void	addSubscription(String name, String startPoint, String mountPoint, String translation, Set labels, boolean occurringSelection, boolean recursive, int level) Add a subscription.
void	changeCover(String coverName) Change the presentation context (cover) of the channel.
void	changeSectionDesign(String sectionID, int designID, boolean allCovers) Change the presentation template (design) for a single section in the channel.
void	changeSectionDesign(String sectionID, String designName, boolean allCovers) Change the presentation template (design) for a single section in the channel.
void	clear() Remove all content from the channel.
void	clearSubscriptions() Remove all subscriptions (including the defaults).
void	close() Close this Channel.
protected void	finalize()
Object	getDatabase() Get the (opaque) database underlying this channel.
Collection	getEntries() Get the (opaque) entries in this channel.
Properties	getLabelDefinitions() Get the effective label definitions (i.e.
String	getLoginName() Get the name with which the Channel is currently logged in.
String	getName() Get the name of the channel this Channel is using.
String	getPassword() Get the plain-text password with which the Channel is currently logged in.
List	getSectionDesigns() Get the list of Section Designs.
String	getServer() Get the name of the server this Channel is using.
void	inheritLabels(String channel) Let the current channel inherit label settings from another channel.
void	inheritPrivacyGroups(String channel) Let the current channel inherit Privacy Group definitions from another channel.
boolean	isLoggedIn()
void	login() Login to a channel with the current credentials.
void	login(String loginName, String password) Login to a channel with the specified credentials.
void	logout() This function is to explicitly forget password information.
void	preload(int delay) Force loading of this channel at the server, using default parameters.
void	removeSection(PathString dst)
void	removeSection(String dst) Remove a Section.
void	setCategories(List categories) Set the categories for this channel.
void	setDatabase(Object database) Set the (opaque) database underlying this channel.
void	setLabelColors(Properties labelColors, boolean merge) Associate colors with the labels.
void	setLabelImages(Properties images, Properties overImages, boolean merge) Associate images with the labels.
void	setLabels(Properties labels, boolean merge) Define the labels for the current channel.
void	setPrivacy(int level) Set privacy level of the entire channel.
void	setPrivacyGroups(Properties friends, Properties closeFriends, Properties bestFriends, Properties owners, boolean merge) Create or set privacy groups.
void	setSectionLabels(String sectionID, Set labels, boolean occurringLabels, boolean merge) Set the labels of a section of the channel.
void	setSectionPrivacy(String sectionID, int level) Set the privacy level of a Section.
void	setStartSection(String sectionID) Set the start section of the channel.
void	setStorable(boolean storable) Use WStorable's setStorable for all cached WStorable's of this channel.
void	setStoreVersion(char v)
void	setTemplatePreference(String oldStream, String oldID, String newStream, String newID) Override template specifications of Entries.
void	sort() Sort contents of all sections in the entire channel by label, type and description (in that order).
void	sort(Vector criteria) Sort contents of all sections in the entire channel by label by application specific criteria.
void	sync() Synchronize all changes with the server.
static void	syncAll() Sync all information that has changed in a single, fast, though memory intensive batch.
void	uploadFile(String name, byte[] contents) Upload a file.
void	uploadImage(String name, byte[] contents) Upload an image.

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PRIVACY_WORLD

public static final int PRIVACY_WORLD

The privacy level 'World'

See Also:

Constant Field Values

PRIVACY_FRIEND

public static final int PRIVACY_FRIEND

The privacy level 'Friend'

See Also:

Constant Field Values

PRIVACY_CLOSE_FRIEND

public static final int PRIVACY_CLOSE_FRIEND

The privacy level 'Close friend'

See Also:

Constant Field Values

PRIVACY_BEST_FRIEND

public static final int PRIVACY_BEST_FRIEND

The privacy level 'Best friend'

See Also:

Constant Field Values

PRIVACY_OWNER

public static final int PRIVACY_OWNER

The privacy level 'Owner'

See Also:

Constant Field Values

SORT_BY_LABELS

public static String SORT_BY_LABELS

Sort by increasing label identifiers

SORT_BY_TYPES

public static String SORT_BY_TYPES

Sort by the object types

SORT_BY_TEXT

public static String SORT_BY_TEXT

Sort by the visible text of objects

SUBSCRIPTION_LABEL_ID

public static final int SUBSCRIPTION_LABEL_ID

The id of the synthetic label that is automatically added to information that comes from a subscription to this channel. Using this id, you can set the symbol and (background) color of the primary subscription symbol.

See Also:

setLabelColors(java.util.Properties, boolean), setLabelImages(java.util.Properties, java.util.Properties, boolean), Constant Field Values

Constructor Detail

Channel

public Channel(String server,
               String name)
        throws ChannelException

Construct a new Channel for the channel with the specified name on the specified server.

Parameters:

server - the server this Channel is using

name - the name of the channel

Throws:

ChannelException

See Also:

Channel(java.lang.String, java.lang.String, java.lang.String, java.lang.String)

Channel

public Channel(String server,
               String name,
               String loginName,
               String password)
        throws ChannelException

Construct a new Channel for the channel with the specified name on the specified server and login with the specified loginName (optional) and password as login credentials.

Parameters:

server - the server ("myhost") or already a serverPath ("https://www.mysecurehost.com:9898/")

name - the name of the channel

loginName - the name to login with, or null to login with the name of the channel itself

password - the password to login with

Throws:

ChannelException - if a problem occurred while logging in

Method Detail

login

public void login()
           throws ChannelException

Login to a channel with the current credentials.

Throws:

ChannelException

See Also:

login(java.lang.String, java.lang.String)

login

public void login(String loginName,
                  String password)
           throws ChannelException

Login to a channel with the specified credentials.

Parameters:

loginName - the name to login with, or null to login with the name of the channel itself

password - the password to login with

Throws:

ChannelException - if a problem occurred while logging in

logout

public void logout()
            throws ChannelException

This function is to explicitly forget password information. There is no need to use it in "casual" applications.

Throws:

ChannelException

isLoggedIn

public boolean isLoggedIn()

Returns:

true if this Channel is logged in to an actual channel on the server?

getServer

public String getServer()

Get the name of the server this Channel is using.

Returns:

the name of the server if the Channel is logged in, or null

getName

public String getName()

Get the name of the channel this Channel is using.

Returns:

the name of the channel if the Channel is logged in, or null

getLoginName

public String getLoginName()

Get the name with which the Channel is currently logged in.

Returns:

the name with which the Channel is currently logged in, or null

getPassword

public String getPassword()

Get the plain-text password with which the Channel is currently logged in.

Returns:

the plain-text password with which the Channel is currently logged in, or null

add

public void add(String source,
                Properties options,
                Properties attribs,
                Properties params)
         throws ChannelException

Add a content entry to the channel. Extensive documentation for this method can be found online, as it is the equivalent of the JavaScript offerContent() API (documented here), except that key=value pairs are used instead of comma separated strings.

Parameters:

source - the source of the entry, or null

options - the entry options, or null

attribs - the HTML attributes of the entry, or null

params - the parameters of the entry, or null

Throws:

ChannelException - if a problem occurred while adding content

addSection

public void addSection(String dst)
                throws ChannelException

Ensure the existence of a Section. Should be be used only in order to create (temporarily) empty sections.

Throws:

ChannelException

addSection

public void addSection(PathString dst)
                throws ChannelException

Throws:

ChannelException

See Also:

addSection(String)

removeSection

public void removeSection(String dst)
                   throws ChannelException

Remove a Section.

Throws:

ChannelException

removeSection

public void removeSection(PathString dst)
                   throws ChannelException

Throws:

ChannelException

See Also:

removeSection(String)

uploadFile

public void uploadFile(String name,
                       byte[] contents)
                throws ChannelException

Upload a file. The URL for the (new) file will be http://'server'/...CHANNEL_PATH.../'channelName'/files/'fileName'. Note: contrary to the end-user operation, no Entry will be added to the channel.

Parameters:

name - the name for the file.

contents - the contents of the file.

Throws:

ChannelException - if a problem occurred while uploading the file

uploadImage

public void uploadImage(String name,
                        byte[] contents)
                 throws ChannelException

Upload an image. The URL for the (new) image will be http://'server'/...CHANNEL_PATH.../'channelName'/images/'imageName'. Note: contrary to the end-user operation, no Entry will be added to the channel.

Parameters:

name - the name for the image.

contents - the contents of the image.

Throws:

ChannelException - if a problem occurred while uploading the image

clear

public void clear()
           throws ChannelException

Remove all content from the channel.

Throws:

ChannelException - if a problem occurred while clearing the channel.

setLabels

public void setLabels(Properties labels,
                      boolean merge)
               throws ChannelException

Define the labels for the current channel.

Parameters:

labels - set of key-value pairs, where key is a (positive integer or predefined) label identifier and value is the description of the label; or null. If unspecified, the current labels will be removed if merge is false.

merge - if true, merge the new labels with the existing ones, overwrite otherwise

Throws:

ChannelException - if a problem occurred while setting the labels

setLabelColors

public void setLabelColors(Properties labelColors,
                           boolean merge)
                    throws ChannelException

Associate colors with the labels. All labels (and some predefined ones) can have a color associate with them. The color is used as the background color for the label images (if any), or as label indicator all by itself.

Parameters:

labelColors - set of key-value pairs, where key is a (positive integer or predefined) label identifier and value is a 6-character hexadecimal color string (e.g. "EE09FF"); or null

merge - if true, merge the new label colors with the existing ones, overwrite otherwise

Throws:

ChannelException - if a problem occurred while setting the label colors

See Also:

setLabels(java.util.Properties, boolean), setLabelImages(java.util.Properties, java.util.Properties, boolean)

setLabelImages

public void setLabelImages(Properties images,
                           Properties overImages,
                           boolean merge)
                    throws ChannelException

Associate images with the labels. All labels (and some predefined ones) can have two images associated with them: a normal image and a mouse-over image. The images are used as label indicators in the end-user environment.

Parameters:

images - set of key-value pairs, where key is a (positive integer or predefined) label identifier and value is a String representing the URL of an image; or null. If unspecified, the existing label/image association will be removed if merge is false.

overImages - set of key-value pairs, where key is a (positive integer or predefined) label identifier and value is a String representing the URL of an image; or null. If unspecified, the existing label/image association will be removed if merge is false.

merge - if true, merge the new label images with the existing ones, overwrite otherwise

Throws:

ChannelException - if a problem occurred while setting the label images

See Also:

setLabels(java.util.Properties, boolean), setLabelColors(java.util.Properties, boolean)

inheritLabels

public void inheritLabels(String channel)
                   throws ChannelException

Let the current channel inherit label settings from another channel. Note: the label that indicates the subscription itself is not inherited.

Parameters:

channel - the channel from which the label settings should be inherited

Throws:

ChannelException - if a problem occurred while setting the label inheritance

getLabelDefinitions

public Properties getLabelDefinitions()
                               throws ChannelException

Get the effective label definitions (i.e. expanded inherited labels).

Throws:

ChannelException - if a problem occurred while getting the label definitions

addSubscription

public void addSubscription(String name,
                            String startPoint,
                            String mountPoint,
                            String translation,
                            Set labels,
                            boolean occurringSelection,
                            boolean recursive,
                            int level)
                     throws ChannelException

Add a subscription.

Parameters:

name - the name of the channel to subscribe to

startPoint - the starting path in the channel subscribed to or null

mountPoint - the path under which this subscription should appear or null

translation - the URL of the translation file or null

labels - the label-identifiers (Strings) of the labels from 'name' to subscribe to. This set may be null or empty, in which case all labels will be included in the subscription.

occurringSelection - if true, a section appears when a single entry matches
if false, a section appears only when all entries in it match

recursive - if true, recursively subscribe to subscriptions from 'name'

level - the privacy level at which this subscription will be visible

Throws:

ChannelException - if a problem occurred while adding the subscription

See Also:

clearSubscriptions()

clearSubscriptions

public void clearSubscriptions()
                        throws ChannelException

Remove all subscriptions (including the defaults).

Throws:

ChannelException - if a problem occurred while removing the subscriptions

changeCover

public void changeCover(String coverName)
                 throws ChannelException

Change the presentation context (cover) of the channel.

Parameters:

coverName - the (internal) name of the cover

Throws:

ChannelException - if a problem occurred while changing the cover

setStartSection

public void setStartSection(String sectionID)
                     throws ChannelException

Set the start section of the channel. The start section is the first section a visitor of the channel will see.

Parameters:

sectionID - either the name of a section, a date in YYYYMMDD- format, or null. If unspecified, the start section will be set to the default ('today').

Throws:

ChannelException

setSectionLabels

public void setSectionLabels(String sectionID,
                             Set labels,
                             boolean occurringLabels,
                             boolean merge)
                      throws ChannelException

Set the labels of a section of the channel.

Parameters:

sectionID - either the name of a section, or a date in YYYYMMDD-format.

labels - a Set of labels.

merge - if true, add the labels, otherwise set them.

Throws:

ChannelException - if a problem occurred while setting the channels on the specified section

changeSectionDesign

public void changeSectionDesign(String sectionID,
                                int designID,
                                boolean allCovers)
                         throws ChannelException

Change the presentation template (design) for a single section in the channel.

Parameters:

sectionID - either the name of a section, or a date in YYYYMMDD-format, indicating the section to set the design for.

designID - the (internal) sequence number of the design.

allCovers - if true, use the design in all covers

Throws:

ChannelException - if a problem occurred while changing the design for the section

See Also:

changeCover(java.lang.String)

changeSectionDesign

public void changeSectionDesign(String sectionID,
                                String designName,
                                boolean allCovers)
                         throws ChannelException

Change the presentation template (design) for a single section in the channel.

Parameters:

sectionID - either the name of a section, or a date in YYYYMMDD-format, indicating the section to set the design for.

designName - the name of the design.

allCovers - if true, use the design in all covers

Throws:

ChannelException - if a problem occurred while changing the design for the section

See Also:

getSectionDesigns()

getSectionDesigns

public List getSectionDesigns()
                       throws ChannelException

Get the list of Section Designs.

Returns:

a List of section design names

Throws:

ChannelException

setPrivacy

public void setPrivacy(int level)
                throws ChannelException

Set privacy level of the entire channel.

Parameters:

level - the new privacy level for the channel

Throws:

ChannelException - if a problem occurred while setting the privacy level

See Also:

PRIVACY_WORLD, PRIVACY_FRIEND, PRIVACY_CLOSE_FRIEND, PRIVACY_BEST_FRIEND, PRIVACY_OWNER

setSectionPrivacy

public void setSectionPrivacy(String sectionID,
                              int level)
                       throws ChannelException

Set the privacy level of a Section.

Parameters:

sectionID - either the name of a section, or a date in YYYYMMDD-format, indicating the section to set the privacy level for

level - the new privacy level of the section

Throws:

ChannelException - if a problem occurred while setting the privacy level

See Also:

PRIVACY_WORLD, PRIVACY_FRIEND, PRIVACY_CLOSE_FRIEND, PRIVACY_BEST_FRIEND, PRIVACY_OWNER

setPrivacyGroups

public void setPrivacyGroups(Properties friends,
                             Properties closeFriends,
                             Properties bestFriends,
                             Properties owners,
                             boolean merge)
                      throws ChannelException

Create or set privacy groups. Privacy groups define the users that have access to this channel at the specified level. Users at higher levels automatically have access at all lower levels as well.

Parameters:

friends - set of key-value pairs, where key is the name of a channel that should be a "friend" of this channel. If the corresponding value is "true", all associated owners of the channel are friends too.

closeFriends - set of key-value pairs, where key is the name of a channel that should be a "good friend" of this channel. If the corresponding value is "true", all associated owners of the channel are close friends too.

bestFriends - set of key-value pairs, where key is the name of a channel that should be a "best friend" of this channel. If the corresponding value is "true", all associated owners of the channel are best friends too.

owners - set of key-value pairs, where key is the name of a channel that should be an associated owner of this channel. If the corresponding value is "true", all associated owners of that channel are associated owners of this one too.

merge - if true merge the groups with the existing ones, overwrite otherwise

Throws:

ChannelException - if a problem occurred while setting the privacy groups

inheritPrivacyGroups

public void inheritPrivacyGroups(String channel)
                          throws ChannelException

Let the current channel inherit Privacy Group definitions from another channel.

Parameters:

channel - the channel from which the Privacy Group definitions should be inherited, or null

Throws:

ChannelException - if a problem occurred while setting the Privacy Group inheritance

setCategories

public void setCategories(List categories)
                   throws ChannelException

Set the categories for this channel. Note: what categories are available depends on the server.

Parameters:

categories - a list of category identifiers (Strings)

Throws:

ChannelException - if a problem occurred while setting the categories

sort

public void sort()
          throws ChannelException

Sort contents of all sections in the entire channel by label, type and description (in that order).

Throws:

ChannelException - if a problem occurred while sorting

See Also:

sort(java.util.Vector)

sort

public void sort(Vector criteria)
          throws ChannelException

Sort contents of all sections in the entire channel by label by application specific criteria.

Parameters:

criteria - a list of criteria (see below) to sort by, in order.

Throws:

ChannelException - if a problem occurred while sorting

See Also:

SORT_BY_LABELS, SORT_BY_TYPES, SORT_BY_TEXT

sync

public void sync()
          throws ChannelException

Synchronize all changes with the server.

Throws:

ChannelException - if a problem occurred while storing

preload

public void preload(int delay)
             throws ChannelException

Force loading of this channel at the server, using default parameters. Useful for very large environments.

Parameters:

delay - the delay in seconds

Throws:

ChannelException - if a problem occurred while loading

close

public void close()

Close this Channel. This method is required in order to enable garbage collection.

setTemplatePreference

public void setTemplatePreference(String oldStream,
                                  String oldID,
                                  String newStream,
                                  String newID)
                           throws ChannelException

Override template specifications of Entries.

Parameters:

oldStream - the template Stream part to override

oldID - the template ID part to override or null (ignored when newID is null)

newStream - the template Stream part replacement

newID - the template ID part replacement or null (ignored when oldID is null)

Throws:

ChannelException

syncAll

public static void syncAll()

Sync all information that has changed in a single, fast, though memory intensive batch.

getDatabase

public Object getDatabase()
                   throws ChannelException

Get the (opaque) database underlying this channel.

Throws:

ChannelException

getEntries

public Collection getEntries()

Get the (opaque) entries in this channel.

setDatabase

public void setDatabase(Object database)
                 throws ChannelException

Set the (opaque) database underlying this channel.

Throws:

ChannelException

setStorable

public void setStorable(boolean storable)

Use WStorable's setStorable for all cached WStorable's of this channel.

setStoreVersion

public void setStoreVersion(char v)
                     throws ChannelException

Throws:

ChannelException

See Also:

Database.setStoreVersion(char)

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable