Constants.java

/**
 * Copyright (c) 2010, 2012 Darmstadt University of Technology.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *    Marcel Bruch - initial API and implementation.
 */
package org.eclipse.recommenders.utils;

import org.eclipse.recommenders.utils.names.IFieldName;
import org.eclipse.recommenders.utils.names.IMethodName;
import org.eclipse.recommenders.utils.names.ITypeName;
import org.eclipse.recommenders.utils.names.VmFieldName;
import org.eclipse.recommenders.utils.names.VmMethodName;
import org.eclipse.recommenders.utils.names.VmTypeName;

public final class Constants {

    private Constants() {
        // Not meant to be instantiated
    }

    /*
     * Repository constants. Used for identifying archives, indexes, fields in indexes in model repository related
     * areas.
     */
    /** {@value} */
    public static final String F_FINGERPRINTS = "fingerprints";
    /** {@value} */
    public static final String F_COORDINATE = "coordinate";
    /** {@value} */
    public static final String F_CLASSIFIER = "classifier";
    /** {@value} */
    public static final String F_SYMBOLIC_NAMES = "symbolic-names";

    /** {@value} */
    public static final String R_COORD_INDEX = "org.eclipse.recommenders:index:zip:0.0.0";

    /** {@value} */
    public static final String EXT_POM = "pom";
    /** {@value} */
    public static final String EXT_ZIP = "zip";
    /** {@value} */
    public static final String EXT_JAR = "jar";
    /** {@value} */
    public static final String EXT_JSON = "json";
    /** {@value} */
    public static final String EXT_JBIF = "jbif";
    /** {@value} */
    public static final String EXT_DATA = "data";
    /** {@value} */
    public static final String EXT_JAVA = "java";
    /** {@value} */
    public static final String EXT_CLASS = "class";

    /** {@value} */
    public static final String DOT_POM = '.' + EXT_POM;
    /** {@value} */
    public static final String DOT_ZIP = '.' + EXT_ZIP;
    /** {@value} */
    public static final String DOT_JAR = '.' + EXT_JAR;
    /** {@value} */
    public static final String DOT_JSON = '.' + EXT_JSON;
    /** {@value} */
    public static final String DOT_JBIF = '.' + EXT_JBIF;
    /** {@value} */
    public static final String DOT_DATA = '.' + EXT_DATA;
    /** {@value} */
    public static final String DOT_JAVA = '.' + EXT_JAVA;
    /** {@value} */
    public static final String DOT_CLASS = '.' + EXT_CLASS;

    /** {@value} */
    public static final String CLASS_CALL_MODELS = "call";
    /** {@value} */
    public static final String CLASS_CTOR_MODEL = "ctor";
    /** {@value} */
    public static final String CLASS_OVRM_MODEL = "ovrm";
    /** {@value} */
    public static final String CLASS_OVRP_MODEL = "ovrp";
    /** {@value} */
    public static final String CLASS_OVRD_MODEL = "ovrd";
    /** {@value} */
    public static final String CLASS_SELFC_MODEL = "selfc";
    /** {@value} */
    public static final String CLASS_SELFM_MODEL = "selfm";

    /*
     * Type and method name constants. Used in many different locations: analysis, networks, etc.
     */
    public static final ITypeName NULL_TYPE = VmTypeName.NULL;

    public static final IMethodName UNKNOWN_METHOD = VmMethodName.get("LECR.unknown()V");
    public static final IMethodName NONE_METHOD = VmMethodName.get("LNone.none()V");
    public static final IMethodName NO_METHOD = VmMethodName.get("LNo.nothing()V");
    public static final IMethodName ANY_METHOD = VmMethodName.get("LAny.any()V");
    public static final IMethodName DUMMY_METHOD = VmMethodName.get("LDummy.dummy()V");
    public static final IFieldName UNKNOWN_FIELD = VmFieldName.get("LNo.field;LNoType");

    /*
     * Network constants. Node names, state names, etc.
     */
    /** {@value} */
    public static final String N_NODEID_CALL_GROUPS = "patterns";
    /** {@value} */
    public static final String N_NODEID_CONTEXT = "contexts";
    /** {@value} */
    public static final String N_NODEID_DEF = "definitions";
    /** {@value} */
    public static final String N_NODEID_DEF_KIND = "kinds";
    /** {@value} */

    public static final String N_STATE_TRUE = "true";
    /** {@value} */
    public static final String N_STATE_FALSE = "false";

    /*
     * Common Result constants
     */
    public static final int REASON_NOT_IN_CACHE = 1;

}