net.java.sip.communicator.service.neomedia
Enum MediaUseCase

java.lang.Object
  java.lang.Enum<MediaUseCase>
      net.java.sip.communicator.service.neomedia.MediaUseCase

All Implemented Interfaces:

Serializable, Comparable<MediaUseCase>

public enum MediaUseCase
extends Enum<MediaUseCase>

The MediaUseCase enumeration contains a list of use-cases for media related. Typically it can be used to differentiate a video call (video comes from webcam) and desktop session (video comes from desktop).

Author:

Sebastien Vincent

Enum Constant Summary

ANY
Represents any usecase.

CALL
Represents a standard call (voice/video).

DESKTOP
Represents a desktop streaming/sharing session.

Method Summary

static MediaUseCase	parseString(String mediaUseCase) Returns a MediaUseCase value corresponding to the specified mediaUseCase.
String	toString() Returns the name of this MediaUseCase.
static MediaUseCase	valueOf(String name) Returns the enum constant of this type with the specified name.
static MediaUseCase[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ANY

public static final MediaUseCase ANY

Represents any usecase.

CALL

public static final MediaUseCase CALL

Represents a standard call (voice/video).

DESKTOP

public static final MediaUseCase DESKTOP

Represents a desktop streaming/sharing session.

Method Detail

values

public static MediaUseCase[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (MediaUseCase c : MediaUseCase.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static MediaUseCase valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Returns the name of this MediaUseCase.

Overrides:

toString in class Enum<MediaUseCase>

Returns:

the name of this MediaUseCase.

parseString

public static MediaUseCase parseString(String mediaUseCase)
                                throws IllegalArgumentException

Returns a MediaUseCase value corresponding to the specified mediaUseCase.

Parameters:

mediaUseCase - the name that we'd like to parse.

Returns:

a MediaUseCase value corresponding to the specified mediaUseCase.

Throws:

IllegalArgumentException - in case mediaUseCase is not a valid or currently supported media usecase.