christophedelory.player
Class PlayerSupport

java.lang.Object
  christophedelory.player.PlayerSupport

All Implemented Interfaces:

Cloneable

public class PlayerSupport
extends Object
implements Cloneable

Information about a player support of a particular multimedia file. A file is supported if it can be parsed by the specified player. Optionnally, it can also be saved.
See also:

• Media player (application software)
• Comparison of media players

Since:

0.2.0

Version:

$Revision: 92 $

Author:

Christophe Delory

Nested Class Summary

static class

PlayerSupport.Player The player type.

Constructor Summary

PlayerSupport(PlayerSupport.Player player, boolean isSaved, String comment)
Builds a new player support information.

Method Summary

Object	clone() Creates and returns a "shallow" copy of this object.
String	getComment() Returns an optional comment associated to this player support.
PlayerSupport.Player	getPlayer() Returns the target player.
boolean	isSaved() Specifies that the target player can also save the mutimedia file, or not.
static String	toString(PlayerSupport.Player player) Returns a string representation of the specified player.

Methods inherited from class java.lang.Object

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

Constructor Detail

PlayerSupport

public PlayerSupport(PlayerSupport.Player player,
                     boolean isSaved,
                     String comment)

Builds a new player support information.

Parameters:

player - the target player. Shall not be null.

isSaved - specifies that the player can also save the mutimedia file, or not.

comment - any comment on this player support. May be null.

Throws:

NullPointerException - if player is null.

Method Detail

toString

public static String toString(PlayerSupport.Player player)

Returns a string representation of the specified player.

Parameters:

player - a player. Shall not be null.

Returns:

a string representing the given player. Shall not be null.

Throws:

NullPointerException - if player is null.

getPlayer

public PlayerSupport.Player getPlayer()

Returns the target player.

Returns:

a player description. Shall not be null.

isSaved

public boolean isSaved()

Specifies that the target player can also save the mutimedia file, or not.

Returns:

the associated boolean.

getComment

public String getComment()

Returns an optional comment associated to this player support.

Returns:

a comment. May be null.

clone

public Object clone()
             throws CloneNotSupportedException

Creates and returns a "shallow" copy of this object.

Overrides:

clone in class Object

Returns:

a clone of this instance.

Throws:

CloneNotSupportedException - shall not be thrown, because this class is cloneable.

Since:

1.0.0

See Also:

Object.clone()