org.moe.tools.natjgen.FrameworkBinding.java Source code

Introduction

Here is the source code for org.moe.tools.natjgen.FrameworkBinding.java

Source

/*
Copyright (C) 2016 Migeran
    
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 org.moe.tools.natjgen;

import com.google.gson.JsonObject;
import com.google.gson.JsonPrimitive;
import org.moe.common.utils.JavaUtil;

/**
 * This class is specialized on Framework configuration.
 */
public class FrameworkBinding extends AbstractBinding {
    /**
     * Binding type.
     */
    public static final String TYPE = "framework";

    /**
     * Validation error: framework path is not set.
     */
    public static final String ERR_FRAMEWORK_PATH_IS_NOT_SET = "framework path is not set";
    /**
     * Validation error: framework path is incorrect, path must point to a <name>.framework directory.
     */
    public static final String ERR_FRAMEWORK_PATH_IS_NOT_FRAMEWORK_DIRECTORY = "framework path is incorrect, path must "
            + "point to a <name>.framework directory";
    /**
     * Validation error: framework path is incorrect, path must use Unix file separators (/).
     */
    public static final String ERR_FRAMEWORK_PATH_MUST_USE_UNIX_FILE_SEPARATORS = "framework path is incorrect, path "
            + "must use Unix file separators (/)";
    /**
     * Validation error: package base is not set.
     */
    public static final String ERR_PACKAGE_BASE_IS_NOT_SET = "package base is not set";
    /**
     * Validation error: package base is not a valid Java package.
     */
    public static final String ERR_PACKAGE_BASE_IS_NOT_A_VALID_JAVA_PACKAGE = "package base is not a valid Java package";
    /**
     * Validation error: import code is not set.
     */
    public static final String ERR_IMPORT_CODE_IS_NOT_SET = "import code is not set";

    /**
     * Path to the framework.
     */
    private String frameworkPath;
    /**
     * Package base for the framework.
     */
    private String packageBase;
    /**
     * Objective-C/C code for importing the framework.
     */
    private String importCode;

    /**
     * Creates a new FrameworkBinding instance.
     */
    public FrameworkBinding() {
        super(TYPE);
    }

    /**
     * Returns the path to the framework.
     *
     * @return Path to the framework
     */
    public String getFrameworkPath() {
        return frameworkPath;
    }

    /**
     * Sets the path to the framework.
     *
     * @param frameworkPath Path to the framework
     */
    public void setFrameworkPath(String frameworkPath) {
        this.frameworkPath = frameworkPath;
    }

    /**
     * Returns the package base for the framework.
     *
     * @return Package base for the framework
     */
    public String getPackageBase() {
        return packageBase;
    }

    /**
     * Sets the package base for the framework.
     *
     * @param packageBase Package base for the framework
     */
    public void setPackageBase(String packageBase) {
        this.packageBase = packageBase;
    }

    /**
     * Returns the Objective-C/C code for importing the framework.
     *
     * @return Objective-C/C code for importing the framework
     */
    public String getImportCode() {
        return importCode;
    }

    /**
     * Sets the Objective-C/C code for importing the framework.
     *
     * @param importCode Objective-C/C code for importing the framework
     */
    public void setImportCode(String importCode) {
        this.importCode = importCode;
    }

    @Override
    public void validate() throws ValidationException {
        validate(frameworkPath != null, ERR_FRAMEWORK_PATH_IS_NOT_SET);
        validate(frameworkPath.length() > 0, ERR_FRAMEWORK_PATH_IS_NOT_SET);
        validate(frameworkPath.endsWith(".framework"), ERR_FRAMEWORK_PATH_IS_NOT_FRAMEWORK_DIRECTORY);
        validate(!frameworkPath.contains("\\"), ERR_FRAMEWORK_PATH_MUST_USE_UNIX_FILE_SEPARATORS);
        validate(packageBase != null, ERR_PACKAGE_BASE_IS_NOT_SET);
        validate(packageBase.length() > 0, ERR_PACKAGE_BASE_IS_NOT_SET);
        validate(JavaUtil.isValidJavaPackage(packageBase), ERR_PACKAGE_BASE_IS_NOT_A_VALID_JAVA_PACKAGE);
        validate(importCode != null, ERR_IMPORT_CODE_IS_NOT_SET);
        validate(importCode.length() > 0, ERR_IMPORT_CODE_IS_NOT_SET);
    }

    /**
     * Returns the name of the framework.
     *
     * @return Name of the framework
     */
    public String getFrameworkName() {
        String framework = this.frameworkPath;
        int lastIndexOf = framework.lastIndexOf('/');
        if (lastIndexOf != -1) {
            framework = framework.substring(lastIndexOf + 1);
        }
        lastIndexOf = framework.lastIndexOf(".framework");
        if (lastIndexOf != -1) {
            framework = framework.substring(0, lastIndexOf);
        }
        return framework;
    }

    /**
     * Returns the parent path of the framework.
     *
     * @return Parent path of the framework
     */
    public String getFrameworkParentPath() {
        String framework = this.frameworkPath;
        int lastIndexOf = framework.lastIndexOf('/');
        if (lastIndexOf != -1) {
            framework = framework.substring(0, lastIndexOf);
        }
        return framework;
    }

    @Override
    public JsonObject getJsonObject() {
        final JsonObject json = super.getJsonObject();
        if (getFrameworkPath() != null) {
            json.addProperty("frameworkPath", getFrameworkPath());
        }
        if (getPackageBase() != null) {
            json.addProperty("packageBase", getPackageBase());
        }
        if (getImportCode() != null) {
            json.addProperty("importCode", getImportCode());
        }
        return json;
    }

    @Override
    public void setJsonObject(JsonObject json) {
        super.setJsonObject(json);

        setFrameworkPath(null);
        final JsonPrimitive jsonFrameworkPath = json.getAsJsonPrimitive("frameworkPath");
        if (jsonFrameworkPath != null) {
            setFrameworkPath(jsonFrameworkPath.getAsString());
        }

        setPackageBase(null);
        final JsonPrimitive jsonPackageBase = json.getAsJsonPrimitive("packageBase");
        if (jsonPackageBase != null) {
            setPackageBase(jsonPackageBase.getAsString());
        }

        setImportCode(null);
        final JsonPrimitive jsonImportCode = json.getAsJsonPrimitive("importCode");
        if (jsonImportCode != null) {
            setImportCode(jsonImportCode.getAsString());
        }
    }
}