Lizzy v1.1.1

christophedelory.playlist.wpl
Class Argument

java.lang.Object
  extended by christophedelory.playlist.wpl.Argument

public class Argument
extends Object

Contains one portion of a condition string. A condition string typically has a condition portion and a value portion. For example, in the condition string "Artist Equals Joe", the condition portion is "Equals" and the value portion is "Joe".
When the name attribute of a fragment element is a media item characteristic such as Album Artist, or Genre, the fragment element must contain two argument elements: one that specifies a condition and another that specifies a value. The following table shows two possible values for the name attribute and how argument elements are used to specify conditions and values:

Attribute value Description
Condition The content of the argument element is the condition portion of a condition string. For example, in the condition string "Artist Equals Joe", the condition portion is "Equals". The condition portion of a condition string must be one of the following: Equals, Does Not Equal, Contains, Does Not Contain, Is Less Than, Is Greater Than, Is, Is Not, Is Before, Is Later Than, Is More Recent Than, Above, Below, Ascending, Descending, Random, Is At Least, Is No More Than.
Value The content of the argument element is the value portion of a condition string. For example, in the condition string "Artist Equals Joe", the value portion is "Joe".
Example:
 <fragment name = "Artist">
  <argument name = "Condition">Equals</argument>
  <argument name = "Value">Joe</argument>
 </fragment>
 
When the name attribute of a fragment element is "Limit Total Size To" or "Limit Total Duration To", the fragment element must contain two argument elements: one that specifies a format and one that specifies a number. The following table shows two possible values for the name attribute and how argument elements are used to limit the size or duration of a playlist:
Attribute value Description
Format When the name attribute of the fragment element is "Limit Total Size To", the content of the argument element must be one of the following: Kilobytes, Megabytes, or Gigabytes.
When the name attribute of the fragment element is "Limit Total Duration To", the content of the argument element must be one of the following: Seconds, Minutes, Hours, or Days.
Number The content of the argument element is a number that limits the size or duration of the playlist.
Examples:
 <fragment name = "Limit Total Size To">
  <argument name = "Format">Megabytes</argument>
  <argument name = "Number">5</argument>
 </fragment>

 <fragment name = "Limit Total Duration To">
  <argument name = "Format">Minutes</argument>
  <argument name = "Number">20</argument>
 </fragment>
 
When the name attribute of a fragment element is "Limit Number of Items", the fragment element must contain one argument element that specifies the number of items. The following table shows how to use the Number value of the name attribute:
Attribute value Description
Number The content of the argument element is a number that limits the number of items in a playlist.
Example:
 <fragment name = "Limit Number of Items">
  <argument name = "Number">15</argument>
 </fragment>
 
Windows Argument Player 9 Series or later.

Version:
$Revision: 92 $
Author:
Christophe Delory

Constructor Summary
Argument()
           
 
Method Summary
 String getContent()
          Returns the content of this argument.
 String getName()
          Returns the name of one portion of the condition string.
 void setContent(String content)
          Initializes the content of this argument.
 void setName(String name)
          Initializes the name of one portion of the condition string.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Argument

public Argument()
Method Detail

getName

public String getName()
Returns the name of one portion of the condition string.

Returns:
the argument name. Shall not be null.
See Also:
setName(java.lang.String)

setName

public void setName(String name)
Initializes the name of one portion of the condition string.

Parameters:
name - the argument name. Shall not be null.
Throws:
NullPointerException - if name is null.
See Also:
getName()

getContent

public String getContent()
Returns the content of this argument.

Returns:
the argument's content. Shall not be null.
See Also:
setContent(java.lang.String)

setContent

public void setContent(String content)
Initializes the content of this argument.

Parameters:
content - the argument's content. Shall not be null.
Throws:
NullPointerException - if content is null.
See Also:
getContent()

© 2008-2009 Christophe Delory

Copyright © 2008-2009 Christophe Delory. All Rights Reserved.