com.smartdevicelink.proxy.rpc

Class PutFileResponse

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.RPCMessage

com.smartdevicelink.proxy.RPCResponse

com.smartdevicelink.proxy.rpc.PutFileResponse

All Implemented Interfaces:

Cloneable

public class PutFileResponse
extends RPCResponse

Put File Response is sent, when PutFile has been called

Since:

SmartDeviceLink 2.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_SPACE_AVAILABLE

Fields inherited from class com.smartdevicelink.proxy.RPCResponse

KEY_INFO, KEY_RESULT_CODE, KEY_SUCCESS

Fields inherited from class com.smartdevicelink.proxy.RPCMessage

function, KEY_CORRELATION_ID, KEY_FUNCTION_NAME, KEY_NOTIFICATION, KEY_PARAMETERS, KEY_REQUEST, KEY_RESPONSE, messageType, parameters

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors

Constructor and Description
PutFileResponse() Constructs a new PutFileResponse object
PutFileResponse(Boolean success, Result resultCode) Constructs a new PutFileResponse object
PutFileResponse(Hashtable<String,Object> hash) Constructs a new PutFileResponse object indicated by the Hashtable parameter

Method Summary

Modifier and Type	Method and Description
void	format(Version rpcVersion, boolean formatParams) SpaceAvailable became optional as of RPC Spec 5.0.
Integer	getSpaceAvailable()
PutFileResponse	setSpaceAvailable(Integer spaceAvailable)

Methods inherited from class com.smartdevicelink.proxy.RPCResponse

getCorrelationID, getInfo, getResultCode, getSuccess, setCorrelationID, setInfo, setResultCode, setSuccess

Methods inherited from class com.smartdevicelink.proxy.RPCMessage

getBoolean, getDouble, getFloat, getFunctionID, getFunctionName, getInteger, getLong, getMessageType, getObject, getParameters, getString, setFunctionName, setParameters

Methods inherited from class com.smartdevicelink.proxy.RPCStruct

clone, deserializeJSON, equals, formatObject, getBulkData, getMessageTypeName, getStore, getStoreValue, getValue, getValueForString, hashCode, hasKey, isPayloadProtected, serializeJSON, serializeJSON, setBulkData, setPayloadProtected, setValue

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

KEY_SPACE_AVAILABLE

public static final String KEY_SPACE_AVAILABLE

See Also:

Constant Field Values

Constructor Detail

PutFileResponse

public PutFileResponse()

Constructs a new PutFileResponse object

PutFileResponse

public PutFileResponse(Hashtable<String,Object> hash)

Constructs a new PutFileResponse object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

PutFileResponse

public PutFileResponse(@NonNull
                       Boolean success,
                       @NonNull
                       Result resultCode)

Constructs a new PutFileResponse object

Parameters:

success - whether the request is successfully processed

resultCode - whether the request is successfully processed

Method Detail

format

public void format(Version rpcVersion,
                   boolean formatParams)

SpaceAvailable became optional as of RPC Spec 5.0. If a system that expected the value to always have a value connects to such a system, it could return null. Check to see if there is a value, and if not, set it to MAX_VALUE as defined by the RPC Spec

Overrides:

format in class RPCStruct

Parameters:

rpcVersion - the rpc spec version that has been negotiated. If value is null the the max value of RPC spec version this library supports should be used.

formatParams - if true, the format method will be called on subsequent params

setSpaceAvailable

public PutFileResponse setSpaceAvailable(Integer spaceAvailable)

getSpaceAvailable

public Integer getSpaceAvailable()