com.matthewtamlin.soundsword.Song.java Source code

Introduction

Here is the source code for com.matthewtamlin.soundsword.Song.java

Source

/*
 * Copyright 2016 Matthew Tamlin
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.matthewtamlin.soundsword;

import android.net.Uri;

import org.apache.commons.lang3.builder.HashCodeBuilder;

import java.io.File;

/**
 * A single Song stored on disk. No IO operations occur at instantiation.
 */
public class Song implements PlayableMedia {
    /**
     * The file on disk containing this Song.
     */
    private final File file;

    /**
     * Constructs a new Song instance. The provided File is not accessed during instantiation.
     *
     * @param file
     *       the File on disk containing this Song
     * @throws IllegalArgumentException
     *       if {@code file} is null
     */
    private Song(final File file) {
        if (file == null) {
            throw new IllegalArgumentException("file cannot be null");
        }

        this.file = file;
    }

    /**
     * Creates a new Song from a file path. The File at {@code path} is not accessed during this
     * method's execution.
     *
     * @param path
     *       the path (relative or absolute) of the the File on disk containing this Song, not null
     * @return the new Song
     * @throws IllegalArgumentException
     *       if {@code path} is null
     */
    public static Song fromFilePath(String path) {
        if (path == null) {
            throw new IllegalArgumentException("path cannot be null");
        }

        return new Song(new File(path));
    }

    /**
     * Creates a new Song from a File. The provided File is not accessed during this method's
     * execution.
     *
     * @param file
     *       the File on disk containing this Song, not null
     * @return the new Song
     * @throws IllegalArgumentException
     *       if {@code file} is null
     */
    public static Song fromFile(final File file) {
        if (file == null) {
            throw new IllegalArgumentException("file cannot be null");
        }

        return new Song(file);
    }

    @Override
    public Uri getUri() {
        return Uri.fromFile(file);
    }

    @Override
    public boolean equals(Object o) {
        if (o == this) {
            return true;
        } else if (o == null) {
            return false;
        } else if (!(o instanceof Song)) {
            return false;
        } else {
            final Song s = (Song) o;
            return s.getUri().equals(this.getUri());
        }
    }

    @Override
    public int hashCode() {
        HashCodeBuilder b = new HashCodeBuilder();
        b.append(file);
        return b.toHashCode();
    }
}