uk.co.caprica.mediascanner.domain.MediaSet Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of media-scanner Show documentation
Scan directories recursively for media, with pluggable title and meta-data parsing.
The newest version!
/*
 * This file is part of media-scanner.
 *
 * media-scanner 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.
 *
 * media-scanner 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 media-scanner.  If not, see .
 *
 * Copyright 2014 Caprica Software Limited.
 */

package uk.co.caprica.mediascanner.domain;

import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
import java.util.Iterator;
import java.util.stream.Collectors;

import com.google.common.base.MoreObjects;
import com.google.common.base.Objects;
import com.google.common.collect.Comparators;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.Iterators;

import static com.google.common.base.MoreObjects.toStringHelper;
import static java.util.stream.Collectors.toList;

/**
 *
 */
public final class MediaSet implements Iterable {

    /**
     *
     */
    private final Collection entries;

    /**
     *
     *
     * @param entries
     */
    public MediaSet(Collection entries) {
        this.entries = ImmutableList.copyOf(entries);
    }

    /**
     * Get the collection of media entries, in default (title) order.
     *
     * @return
     */
    public Collection entries() {
        return entries;
    }

    /**
     * Get the collection of media entries, in full path-name order.
     *
     * @return
     */
    public Collection entriesInPathOrder() {
        return entries.stream().sorted(Comparator.comparing(MediaEntry::file)).collect(toList());
    }

    /**
     *
     *
     * @return
     */
    public int size() {
        return entries.size();
    }

    @Override
    public int hashCode() {
        return Objects.hashCode(
            entries
        );
    }

    @Override
    public boolean equals(Object obj) {
        if (obj == this) {
            return true;
        }
        if (!(obj instanceof MediaSet)) {
            return false;
        }
        MediaSet other = (MediaSet) obj;
        return
            Objects.equal(entries, other.entries);
    }

    @Override
    public String toString() {
        return toStringHelper(this)
            .add("entries", entries.size())
            .toString();
    }

    @Override
    public Iterator iterator() {
        return Iterators.unmodifiableIterator(entries.iterator());
    }
}