net.dv8tion.jda.core.entities.Icon.java Source code

Introduction

Here is the source code for net.dv8tion.jda.core.entities.Icon.java

Source

/*
 *     Copyright 2015-2016 Austin Keener & Michael Ritter
 *
 * 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 net.dv8tion.jda.core.entities;

import net.dv8tion.jda.core.utils.IOUtil;
import org.apache.commons.codec.binary.StringUtils;
import org.apache.http.util.Args;

import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.util.Base64;

/**
 * Icon containing a base64 encoded jpeg image.
 */
public class Icon {
    protected final String encoding;

    protected Icon(String base64Encoding) {
        this.encoding = "data:image/jpeg;base64," + base64Encoding;
    }

    /**
     * The base64 encoded data for this Icon
     *
     * @return
     *      String representation of the encoded data for this icon
     */
    public String getEncoding() {
        return encoding;
    }

    /**
     * Creates an {@link Icon Icon} with the specified {@link java.io.File File}.<br>
     * We here read the specified File and forward the retrieved byte data to {@link #from(byte[])}.
     *
     * @param file
     *      An existing, not-null file.
     * @return
     *      An Icon instance representing the specified File
     * @throws IllegalArgumentException
     *      if the provided file is either null or does not exist
     * @throws IOException
     *      if there is a problem while reading the file.
     * @see net.dv8tion.jda.core.utils.IOUtil#readFully(File)
     */
    public static Icon from(File file) throws IOException {
        Args.notNull(file, "Provided File");
        Args.check(file.exists(), "Provided file does not exist!");

        return from(IOUtil.readFully(file));
    }

    /**
     * Creates an {@link Icon Icon} with the specified {@link java.io.InputStream InputStream}.<br>
     * We here read the specified InputStream and forward the retrieved byte data to {@link #from(byte[])}.
     *
     * @param stream
     *      A not-null InputStream.
     * @return
     *      An Icon instance representing the specified InputStream
     * @throws IllegalArgumentException
     *      if the provided stream is null
     * @throws IOException
     *      If the first byte cannot be read for any reason other than the end of the file,
     *      if the input stream has been closed, or if some other I/O error occurs.
     * @see net.dv8tion.jda.core.utils.IOUtil#readFully(InputStream)
     */
    public static Icon from(InputStream stream) throws IOException {
        Args.notNull(stream, "InputStream");

        return from(IOUtil.readFully(stream));
    }

    /**
     * Creates an {@link Icon Icon} with the specified image data.
     *
     * @param data
     *      not-null image data bytes.
     * @return
     *      An Icon instance representing the specified image data
     * @throws IllegalArgumentException
     *      if the provided data is null
     */
    public static Icon from(byte[] data) {
        Args.notNull(data, "Provided byte[]");

        String encoding = StringUtils.newStringUtf8(Base64.getEncoder().encode(data));
        return new Icon(encoding);
    }
}