com.smartdevicelink.proxy.rpc.ModuleInfo Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sdl_java_se Show documentation

The app library component of SDL is meant to run on the end userâs smart-device from within SDL enabled apps, as an embedded app, or connected to the cloud. App libraries allow the apps to connect to SDL enabled head-units and hardware through bluetooth, USB, and TCP for Android, and cloud and embedded apps can connect through web sockets, Java Beans, and other custom transports. Once the library establishes a connection between the smart device and head-unit through the preferred method of transport, the two components are able to communicate using the SDL defined protocol. The app integrating this library project is then able to expose its functionality to the head-unit through text, media, and other interactive elements.

There is a newer version: 5.7.0

Show newest version

package com.smartdevicelink.proxy.rpc;

import androidx.annotation.NonNull;

import com.smartdevicelink.proxy.RPCStruct;

import java.util.Hashtable;

/**
 * Struct that describes a module within different SystemCapabilities
 */
public class ModuleInfo extends RPCStruct {
    public static final String KEY_MODULE_ID = "moduleId";
    public static final String KEY_MODULE_LOCATION = "location";
    public static final String KEY_MODULE_SERVICE_AREA = "serviceArea";
    public static final String KEY_MULTIPLE_ACCESS_ALLOWED = "allowMultipleAccess";

    public ModuleInfo() {
    }

    public ModuleInfo(Hashtable hash) {
        super(hash);
    }

    /**
     * Struct that describes a module within different SystemCapabilities
     *
     * @param moduleId Sets the Module ID for this Module
     */
    public ModuleInfo(@NonNull String moduleId) {
        this();
        setModuleId(moduleId);
    }

    /**
     * Sets the Module ID for this Module
     *
     * @param id the id to be set
     */
    public ModuleInfo setModuleId(@NonNull String id) {
        setValue(KEY_MODULE_ID, id);
        return this;
    }

    /**
     * Gets the Module ID for this module
     *
     * @return the Module ID as a String
     */
    public String getModuleId() {
        return getString(KEY_MODULE_ID);
    }

    /**
     * Sets the location of this Module
     *
     * @param location the location to be set
     */
    public ModuleInfo setModuleLocation(Grid location) {
        setValue(KEY_MODULE_LOCATION, location);
        return this;
    }

    /**
     * Gets the location of this Module
     *
     * @return the location of this Module
     */
    public Grid getModuleLocation() {
        return (Grid) getObject(Grid.class, KEY_MODULE_LOCATION);
    }

    /**
     * Sets the service area of this Module
     *
     * @param serviceArea the service area of this Module
     */
    public ModuleInfo setModuleServiceArea(Grid serviceArea) {
        setValue(KEY_MODULE_SERVICE_AREA, serviceArea);
        return this;
    }

    /**
     * Gets the service area of this Module
     *
     * @return the service area of this Module
     */
    public Grid getModuleServiceArea() {
        return (Grid) getObject(Grid.class, KEY_MODULE_SERVICE_AREA);
    }

    /**
     * Sets the multiple access allowance for this Module
     *
     * @param isMultipleAccess the access to be set
     */
    public ModuleInfo setMultipleAccessAllowance(Boolean isMultipleAccess) {
        setValue(KEY_MULTIPLE_ACCESS_ALLOWED, isMultipleAccess);
        return this;
    }

    /**
     * Gets the multiple allowance access of this Module
     *
     * @return the multiple access allowance of this Module
     */
    public Boolean getMultipleAccessAllowance() {
        return getBoolean(KEY_MULTIPLE_ACCESS_ALLOWED);
    }
}