org.asteriskjava.fastagi.command

Class HangupCommand

java.lang.Object

org.asteriskjava.fastagi.command.AbstractAgiCommand

org.asteriskjava.fastagi.command.HangupCommand

All Implemented Interfaces:

Serializable, AgiCommand

public class HangupCommand
extends AbstractAgiCommand

Hangs up the specified channel. If no channel name is given, hangs up the current channel.

Version:

$Id$

Author:

srt

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
HangupCommand() Creates a new HangupCommand that hangs up the current channel.
HangupCommand(String channel) Creates a new HangupCommand that hangs up the given channel.

Method Summary

Modifier and Type	Method and Description
String	buildCommand() Returns a string suitable to be sent to asterisk.
String	getChannel() Returns the name of the channel to hangup.
void	setChannel(String channel) Sets the name of the channel to hangup.

Methods inherited from class org.asteriskjava.fastagi.command.AbstractAgiCommand

escapeAndQuote, escapeAndQuote, setAsteriskVersion, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

HangupCommand

public HangupCommand()

Creates a new HangupCommand that hangs up the current channel.

HangupCommand

public HangupCommand(String channel)

Creates a new HangupCommand that hangs up the given channel.

Parameters:

channel - the name of the channel to hangup.

Method Detail

getChannel

public String getChannel()

Returns the name of the channel to hangup.

Returns:

the name of the channel to hangup or null for the current channel.

setChannel

public void setChannel(String channel)

Sets the name of the channel to hangup.

Parameters:

channel - the name of the channel to hangup or null for the current channel.

buildCommand

public String buildCommand()

Description copied from interface: AgiCommand

Returns a string suitable to be sent to asterisk.

Specified by:

buildCommand in interface AgiCommand

Specified by:

buildCommand in class AbstractAgiCommand

Returns:

a string suitable to be sent to asterisk.