• Home
• com.smartdevicelink
• sdl_java_se
• 5.6.1
• source code
• Turn.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

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

/*
 * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following
 * disclaimer in the documentation and/or other materials provided with the
 * distribution.
 *
 * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from this
 * software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
package com.smartdevicelink.proxy.rpc;

import com.smartdevicelink.proxy.RPCStruct;

import java.util.Hashtable;

/**
 * Describes a navigation turn including an optional icon
 *
 * 
Parameter List

 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
Name
Type
Description
SmartDeviceLink Ver. Available
navigationText
String
Text to describe the turn (e.g. street name)
 * 

 * 
Maxlength = 500
 * 
 * 
SmartDeviceLink 2.0
turnIcon
Image
Image to be shown for a turn
SmartDeviceLink 2.0
 *
 * @since SmartDeviceLink 2.0
 */
public class Turn extends RPCStruct {
    public static final String KEY_NAVIGATION_TEXT = "navigationText";
    public static final String KEY_TURN_IMAGE = "turnIcon";

    public Turn() {
    }

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

    /**
     * set the text to describe the turn (e.g. street name)
     *
     * @param navigationText the text to describe the turn (e.g. street name)
     */
    public Turn setNavigationText(String navigationText) {
        setValue(KEY_NAVIGATION_TEXT, navigationText);
        return this;
    }

    /**
     * get the text to describe the turn (e.g. street name)
     *
     * @return the text to describe the turn (e.g. street name)
     */
    public String getNavigationText() {
        return getString(KEY_NAVIGATION_TEXT);
    }

    /**
     * set Image to be shown for a turn
     *
     * @param turnIcon the image to be shown for a turn
     */
    public Turn setTurnIcon(Image turnIcon) {
        setValue(KEY_TURN_IMAGE, turnIcon);
        return this;
    }

    /**
     * get the image to be shown for a turn
     *
     * @return the image to be shown for a turn
     */
    public Image getTurnIcon() {
        return (Image) getObject(Image.class, KEY_TURN_IMAGE);
    }

}