rocks.xmpp.extensions.avatar.AvatarChangeEvent Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xmpp-extensions-client Show documentation

Client side business logic for XMPP extensions

There is a newer version: 0.9.1

Show newest version

/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2014-2016 Christian Schudt
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

package rocks.xmpp.extensions.avatar;

import rocks.xmpp.addr.Jid;
import rocks.xmpp.extensions.avatar.AvatarManager.ConversionException;

import java.awt.image.BufferedImage;
import java.util.EventObject;
import java.util.logging.Level;
import java.util.logging.Logger;

import static rocks.xmpp.extensions.avatar.AvatarManager.asBufferedImage;

/**
 * The avatar change event to notify about avatar updates.
 *
 * @author Christian Schudt
 */
public final class AvatarChangeEvent extends EventObject {
	private static final Logger LOGGER = Logger.getLogger(AvatarManager.class.getName());

    private final Jid contact;

    private final byte[] avatar;

    /**
     * Constructs a prototypical Event.
     *
     * @param source The object on which the Event initially occurred.
     * @throws IllegalArgumentException if source is null.
     */
    AvatarChangeEvent(AvatarManager source, Jid contact, byte[] avatar) {
        super(source);
        this.contact = contact;
        this.avatar = avatar;
    }

    /**
     * Gets the avatar image data.
     *
     * @return The avatar.
     */
    public final byte[] getAvatar() {
        return avatar;
    }

	/**
	 * Gets the avatar image, or {@code null} if there is none.
	 * 
	 * @return The avatar image.
	 */
	public final BufferedImage getAvatarImage() {
		try {
			return this.avatar == null ? null : asBufferedImage(this.avatar);
		} catch (final ConversionException e) {
			LOGGER.log(Level.SEVERE, "Cannot convert avatar image");
			return null;
		}
	}
    
    /**
     * Gets the bare JID of the contact who's associated with the avatar, i.e. who changed his or her avatar.
     *
     * @return The contact.
     */
    public final Jid getContact() {
        return contact;
    }
}