Toaster.java

/*
 * Copyright 2014 Artem Chikin
 * Copyright 2014 Artem Herasymchuk
 * Copyright 2014 Tom Krywitsky
 * Copyright 2014 Henry Pabst
 * Copyright 2014 Bradley Simons
 * 
 * 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 ca.ualberta.cmput301w14t08.geochan.helpers;

import android.content.Context;
import android.widget.Toast;

/**
 * Shows a toast with a given message on screen.
 * Stores the context so that this class can easily be called
 * within any part of the application that runs on the UI thread.
 * Is a singleton.
 * 
 * @author Artem Herasymchuk
 */
public class Toaster {

    private Context context;
    private static Toaster instance;

    /** 
     * Constructs the Toaster object.
     * @param context  The context the Toaster is running in.
     */
    private Toaster(Context context) {
        this.context = context;
    }

    /**
     * Generates an instance of the Toaster singleton object.
     * @param context  The context the Toaster is running in.
     */
    public static void generateInstance(Context context) {
        instance = new Toaster(context);
    }

    /**
     * Shows a short Toast message.
     * @param message  The message to be displayed.
     */
    public static void toastShort(String message) {
        Toast.makeText(instance.context, message, Toast.LENGTH_SHORT).show();
    }

    /**
     * Shows a long Toast message.
     * @param message  The message to be displayed.
     */
    public static void toastLong(String message) {
        Toast.makeText(instance.context, message, Toast.LENGTH_LONG).show();
    }
}