ModuleClassAdvertisement (Project JXTA J2SE API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Project JXTA

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

net.jxta.protocol
Class ModuleClassAdvertisement

java.lang.Object
  net.jxta.document.Advertisement
      net.jxta.document.ExtendableAdvertisement
          net.jxta.protocol.ModuleClassAdvertisement

All Implemented Interfaces:: Cloneable

public abstract class ModuleClassAdvertisement
extends ExtendableAdvertisement
implements Cloneable
extends ExtendableAdvertisement
implements Cloneable

A ModuleClassAdvertisement describes a module class. Its main purpose is to formally document the existence of a module class.

See Also:: ModuleClassID

Constructor Summary
`ModuleClassAdvertisement()`

Method Summary
`Object`	`clone()` Clone this ModuleClassAdvertisement
`static String`	`getAdvertisementType()` Returns the identifying type of this Advertisement.
`String`	`getBaseAdvType()` Returns the base type of this advertisement hierarchy.
`String`	`getDescription()` returns the keywords/description associated with this class
`ID`	`getID()` returns a unique ID for that advertisement (for indexing purposes).
`ModuleClassID`	`getModuleClassID()` returns the id of the class
`String`	`getName()` returns the name of the class
`void`	`setDescription(String description)` sets the description associated with this class
`void`	`setModuleClassID(ModuleClassID id)` sets the id of the class
`void`	`setName(String name)` sets the name of the class

Methods inherited from class net.jxta.document.ExtendableAdvertisement
`getDocument, handleElement`

Methods inherited from class net.jxta.document.Advertisement
`getAdvType, getIndexFields, toString`

Methods inherited from class java.lang.Object
`equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Constructor Detail

ModuleClassAdvertisement

public ModuleClassAdvertisement()

Method Detail

getAdvertisementType

public static String getAdvertisementType()

Returns the identifying type of this Advertisement.

Returns:: String the type of advertisement

getBaseAdvType

public final String getBaseAdvType()

Returns the base type of this advertisement hierarchy. Typically, only the most basic advertisement of a type will implement this method and declare it as final.

Specified by:: getBaseAdvType in class ExtendableAdvertisement

Returns:: String the base type of advertisements in this hierarchy.

clone

public Object clone()

Clone this ModuleClassAdvertisement

Overrides:: clone in class Advertisement

Returns:: Object an object of class ModuleClassAdvertisement that is a deep-enough copy of this one.

getName

public String getName()

returns the name of the class

Returns:: String name of the class

setName

public void setName(String name)

sets the name of the class

Parameters:: name - name of the class to be set

getDescription

public String getDescription()

returns the keywords/description associated with this class

Returns:: String keywords/description associated with the class

setDescription

public void setDescription(String description)

sets the description associated with this class

Parameters:: description -

getModuleClassID

public ModuleClassID getModuleClassID()

returns the id of the class

Returns:: ModuleClassID the class id

setModuleClassID

public void setModuleClassID(ModuleClassID id)

sets the id of the class

Parameters:: id - The id of the class

getID

public ID getID()

returns a unique ID for that advertisement (for indexing purposes). The classID uniquely identifies this adv.

Specified by:: getID in class Advertisement

Returns:: ID the class ID as a basic ID.