fipaos.ont.fipa.fipaman
Class APTDescription


public class APTDescription
implements Serializable

The Agent Platform Transport Description forms part of an AP description (see [PC00023]) and is expressed in SL0
TODO: there is at present no checking to see if the characters in the fields are valid as per the BNF definitions




Constructor Summary
APTDescription()
          This is the empty constructor.
APTDescription(String description)
          Constructs a APTDescription object from a string

Method Summary
 booleanaddMTPD(MTPDescription mtpd)
          Add a message transport protocol to the list
 booleancontains(String name)
          Does the set contain a particular message transport protocol.
 SetgetMTPSSet()
          This method returns the set of message transport protocols
 static voidmain(String[] args)
          The main method is for testing purposes
 booleanremoveMTPD(MTPDescription mtpd)
          Remove a message transport protocol from the set
 voidsetMTPSSet(Set mtpd)
          This method sets the message transport protocol set
 voidsetMTPSSet(MTPDescription[] mtpd)
          This method sets the message transport protocol set.
 StringtoString()
          A String Representation of this ATPDescription object

Constructor Detail

APTDescription

public APTDescription()
This is the empty constructor.

APTDescription

public APTDescription(String description)
throws fipaos.parser.ParserException
Constructs a APTDescription object from a string
Parameters:
description - string representation of a APTDescription object
Throws:
ParserException - if the String is invalid
Method Detail

addMTPD

public boolean addMTPD(MTPDescription mtpd)
Add a message transport protocol to the list
Parameters:
mtpd - the mtpd to be added to the set
Returns: boolean - true if operation successful, false if not

contains

public boolean contains(String name)
Does the set contain a particular message transport protocol. This can be either the profile name or the message transport protocol name
Parameters:
name - the name of message transport protocol or the mtp profile
Returns: boolean - true if the protocol is in the set, false if not

getMTPSSet

public Set getMTPSSet()
This method returns the set of message transport protocols
Returns: a set of message transport protocols

main

public static void main(String[] args)
The main method is for testing purposes
Parameters:
args - Arguments

removeMTPD

public boolean removeMTPD(MTPDescription mtpd)
Remove a message transport protocol from the set
Parameters:
mtpd - remove a MTPD from the set
Returns: boolean - true if operation successful, false if not.

setMTPSSet

public void setMTPSSet(Set mtpd)
This method sets the message transport protocol set
Parameters:
mtpd - MTPD to be added to the set

setMTPSSet

public void setMTPSSet(MTPDescription[] mtpd)
This method sets the message transport protocol set.
Parameters:
mtpd - array of MTPDs to be added to the set

toString

public String toString()
A String Representation of this ATPDescription object
Returns: A string representation of this ATPDescription object

Association Links

to Class java.util.Set

A set of the message transport protocols