Android Open Source - magicAnnotator Annotator Service

From Project

Back to project page magicAnnotator.

License

The source code is released under:

GNU General Public License

If you think the Android project magicAnnotator listed in this page is inappropriate, such as containing malicious code/tools or violating the copyright, please email info at java2s dot com, thanks.

Java Source Code

/*
 * Magic Annotator - The only thing you need to write down whatever you want.
 * Copyright (C) 2013 Nahuel Barrios <barrios.nahuel@gmail.com>.
 *//  w  w w .j ava 2 s  .c om
 *     This program is free software: you can redistribute it and/or modify
 *     it under the terms of the GNU General Public License as published by
 *     the Free Software Foundation, either version 3 of the License, or
 *     (at your option) any later version.
 *
 *     This program is distributed in the hope that it will be useful,
 *     but WITHOUT ANY WARRANTY; without even the implied warranty of
 *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *     GNU General Public License for more details.
 *
 *     You should have received a copy of the GNU General Public License
 *     along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

/**
 * Created by: Nahuel Barrios.
 * On: 19/10/2012 at 12:17hs.
 */
package com.nbempire.android.magicannotator.service;

import android.app.Activity;
import com.nbempire.android.magicannotator.domain.game.Game;

/**
 * Service for the annotators.
 *
 * @author Nahuel Barrios.
 * @since 15
 */
public interface AnnotatorService {

    /**
     * Get the associated annotator Id for the specified {@code userSelection}.
     *
     * @param userSelection
     *         The name of one game. It has to be unique for the app.
     *
     * @return The Id of the annotator that matchs the specified {@code userSelection}.
     *
     * @throws IllegalArgumentException
     *         when the {@code userSelection} is {@code null} or if there isn't any annotator that matches the specified {@code userSelection}.
     * @since 1
     */
    int getAnnotatorId(String userSelection);

    /**
     * Creates an instance of games based on a specific {@code annotatorId}.
     *
     * @param annotatorId
     *         the annotator id
     *
     * @return An instance of Game based on the specified {@code annotatorId}. {@code null} when there isn't any Game for the specified {@code
     *         annotatorId}.
     *
     * @since 1
     */
    Game getAnnotatorGame(int annotatorId);

    /**
     * Inspect which annotator activity has to return based on the specified {@code game} parameter.
     *
     * @param game
     *         A Game associated with some annotator Activity.
     *
     * @return The corresponding annotator activity for the specified {@code game}.
     *
     * @throws IllegalArgumentException
     *         When there isn't any Activity for the specified {@code game}.
     * @since 1
     */
    public Class<? extends Activity> get(Game game) throws IllegalArgumentException;
}

Java Source Code List