/*
 * Copyright (C) 2010 The Android Open Source Project
 *
 * 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.android.launcher2;

import android.animation.Animator;

import java.util.HashSet;

/**
 * This adapter class provides empty implementations of the methods from {@link android.animation.Animator.AnimatorListener}.
 * Any custom listener that cares only about a subset of the methods of this listener can
 * simply subclass this adapter class instead of implementing the interface directly.
 */
public abstract class LauncherAnimatorListenerAdapter implements Animator.AnimatorListener {
    HashSet<Animator> cancelled = new HashSet<Animator>();

    /**
     * {@inheritDoc}
     */
    @Override
    public final void onAnimationCancel(Animator animation) {
        onAnimationEndOrCancel(animation);
        cancelled.add(animation);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public final void onAnimationEnd(Animator animation) {
        if (!cancelled.contains(animation)) onAnimationEndOrCancel(animation);
        cancelled.remove(animation);
    }

    /**
     * Like onAnimationEnd, except it's called immediately in the case on onAnimationCancel, and
     * it's only called once in that case
     */
    public void onAnimationEndOrCancel(Animator animation) {
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void onAnimationRepeat(Animator animation) {
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void onAnimationStart(Animator animation) {
    }

}