src/plugins/handset/src/com/motorola/studio/android/handset/HandsetInstanceBuilder.java

/*
 * Copyright (C) 2012 The Android Open Source Project
 *
 * 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 com.motorola.studio.android.handset;

import java.util.Properties;

import org.eclipse.core.runtime.IPath;
import org.eclipse.sequoyah.device.framework.model.IInstanceBuilder;

/**
 * DESCRIPTION:
 * <br>
 * This class knows how to build TmL instances of handsets
 * <br>
 * RESPONSIBILITY:
 * <br>
 * Creates TmL instances of handsets
 * <br>
 * COLABORATORS:
 * <br>
 * None
 * <br>
 * USAGE:
 * <br>
 * This class is intended to be used by TmL only
 */
public class HandsetInstanceBuilder implements IInstanceBuilder
{
    private final Properties properties;

    private final String name;

    /**
     * Creates a new Instance Builder with the given information.
     * 
     * @param instanceName the name of the instance to be created using this builder
     * @param properties the properties of the instance to be created using this builder
     */
    public HandsetInstanceBuilder(String instanceName, Properties properties)
    {
        this.properties = properties;
        this.name = instanceName;
    }

    /**
     * Always returns <code>null</code> since this information does
     * not make sense for Android Handset Instances.
     */
    public IPath getLocationPath()
    {
        return null;
    }

    /**
     * Retrieves the name of the instance to be created using this builder
     * 
     * @return the name of the instance to be created using this builder
     */
    public String getProjectName()
    {
        return name;
    }

    /**
     * Retrieves the properties of the instance to be created using this builder
     * 
     * @return the properties of the instance to be created using this builder
     */
    public Properties getProperties()
    {
        return properties;
    }

    /**
     * Retrieves the value of the give property key.
     * 
     * @param key the key of the property
     * 
     * @return the value for the property for the instance to be created using this builder
     */
    public String getProperty(String key)
    {
        return properties.getProperty(key);
    }
}