christophedelory.playlist.wpl.Body Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of lizzy Show documentation

Multimedia playlist parser, supporting a wide range of playlist file formats.

There is a newer version: 4.1.1

/*
 * Copyright (c) 2008, Christophe Delory
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *   * Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY CHRISTOPHE DELORY ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL CHRISTOPHE DELORY BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package christophedelory.playlist.wpl;

/**
 * Contains the elements that define the contents of a playlist.
 * The contents of a playlist are organized within a seq element that is contained within the body element.
 * Typically there is either one seq element that defines a static set of media items and contains media elements,
 * or there is one that defines a dynamic set of media items and contains a smartPlaylist element.
 * 

 * Windows Media Player 9 Series or later.
 * @version $Revision: 92 $
 * @author Christophe Delory
 * @castor.class xml="body"
 */
public class Body
{
    /**
     * The body sequence.
     */
    private Seq _seq = new Seq();

    /**
     * Returns the body sequence.
     * @return a sequence. Shall not be null.
     * @see #setSeq
     * @castor.field
     *  get-method="getSeq"
     *  set-method="setSeq"
     *  required="true"
     * @castor.field-xml
     *  name="seq"
     *  node="element"
     */
    public Seq getSeq()
    {
        return _seq;
    }

    /**
     * Initializes the body sequence.
     * @param seq a sequence. Shall not be null.
     * @throws NullPointerException if seq is null.
     * @see #getSeq
     */
    public void setSeq(final Seq seq)
    {
        if (seq == null)
        {
            throw new NullPointerException("No body sequence");
        }

        _seq = seq;
    }
}