io.github.minime89.passbeam.keyboard.Keysyms.java Source code

Introduction

Here is the source code for io.github.minime89.passbeam.keyboard.Keysyms.java

Source

/*
 * Copyright (C) 2015 Marcel Lehwald
 *
 * 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/>.
 */
package io.github.minime89.passbeam.keyboard;

import android.util.Log;

import org.json.JSONArray;
import org.json.JSONException;
import org.json.JSONObject;
import org.simpleframework.xml.ElementList;
import org.simpleframework.xml.Root;

import java.util.Collection;
import java.util.Collections;

import io.github.minime89.passbeam.FileManager;

@Root(strict = false)
public class Keysyms {
    private static final String TAG = Keysyms.class.getSimpleName();
    public static final String DEFAULT_ID = "default";

    /**
     *
     */
    private final Collection<Keysym> keysyms;

    /**
     * Load the keysyms with the specified keysyms ID.
     *
     * @param keysymsId The keysyms ID.
     * @return Returns loaded keysyms.
     * @throws FileManager.FileManagerException When keysyms couldn't be loaded.
     */
    public static Keysyms load(String keysymsId) throws FileManager.FileManagerException {
        FileManager fileManager = new FileManager();

        return fileManager.loadKeysyms(keysymsId);
    }

    private Keysyms(@ElementList(name = "keysyms", inline = true, required = true) Collection<Keysym> keysyms) {
        this.keysyms = Collections.unmodifiableCollection(keysyms);
    }

    /**
     * Build all keysyms. This will call {@link Keysym#build(Converter)} for every keysym in
     * {@link #keysyms}. Any failed keysym build attempts will be ignored.
     *
     * @param converter The converter used for possible keycode, keysym and scancode lookups.
     */
    public void build(Converter converter) {
        for (Keysym keysym : keysyms) {
            try {
                keysym.build(converter);
            } catch (Keysym.KeysymBuildException e) {
                Log.v(TAG, e.getMessage());
            }
        }
    }

    public Keysym find(Keysym.Ref keysymRef) {
        for (Keysym keysym : keysyms) {
            if (keysym.equals(keysymRef)) {
                return keysym;
            }
        }

        return null;
    }

    @ElementList(name = "keysyms", inline = true, required = true)
    public Collection<Keysym> getKeysyms() {
        return keysyms;
    }

    public JSONObject dump() throws JSONException {
        JSONObject obj = new JSONObject();

        JSONArray keysymsArr = new JSONArray();
        for (Keysym keysym : keysyms) {
            keysymsArr.put(keysym.dump());
        }
        obj.put("keysyms", keysymsArr);

        return obj;
    }

    @Override
    public String toString() {
        try {
            return dump().toString();
        } catch (JSONException e) {
            return super.toString();
        }
    }
}