uk.co.caprica.vlcj.player.base.ChapterDescription Maven / Gradle / Ivy

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

Java Framework for the vlc Media Player.

There is a newer version: 5.0.0-M1

/*
 * This file is part of VLCJ.
 *
 * VLCJ is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * VLCJ is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with VLCJ.  If not, see .
 *
 * Copyright 2009-2019 Caprica Software Limited.
 */

package uk.co.caprica.vlcj.player.base;

/**
 * Chapter description.
 */
public final class ChapterDescription {

    /**
     * Chapter offset (milliseconds).
     */
    private final long offset;

    /**
     * Chapter duration (milliseconds).
     */
    private final long duration;

    /**
     * Chapter name.
     */
    private final String name;

    /**
     * Create a new chapter description.
     *
     * @param offset chapter offset (milliseconds)
     * @param duration chapter duration (milliseconds)
     * @param name chapter name
     */
    public ChapterDescription(long offset, long duration, String name) {
        this.offset = offset;
        this.duration = duration;
        this.name = name;
    }

    /**
     * Get the chapter offset.
     *
     * @return offset (milliseconds)
     */
    public long offset() {
        return offset;
    }

    /**
     * Get the duration.
     *
     * @return duration (milliseconds)
     */
    public long duration() {
        return duration;
    }

    /**
     * Get the name.
     *
     * @return name
     */
    public String name() {
        return name;
    }

    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder(60);
        sb.append(getClass().getSimpleName()).append('[');
        sb.append("offset=").append(offset).append(',');
        sb.append("duration=").append(duration).append(',');
        sb.append("name=").append(name).append(']');
        return sb.toString();
    }

}