com.smartdevicelink.managers.file.filetypes

Class SdlFile

java.lang.Object

com.smartdevicelink.managers.file.filetypes.SdlFile

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

SdlArtwork

public class SdlFile
extends Object
implements Cloneable

A class representing data to be uploaded to core

Constructor Summary

Constructors

Constructor and Description
SdlFile() Creates a new instance of SdlFile
SdlFile(StaticIconName staticIconName) Creates a new instance of SdlFile
SdlFile(String fileName, FileType fileType, byte[] data, boolean persistentFile) Creates a new instance of SdlFile
SdlFile(String fileName, FileType fileType, int id, boolean persistentFile) Creates a new instance of SdlFile
SdlFile(String fileName, FileType fileType, Uri uri, boolean persistentFile) Creates a new instance of SdlFile

Method Summary

Modifier and Type	Method and Description
SdlFile	clone() Creates a deep copy of the object
boolean	equals(Object o) Uses our custom hashCode for SdlFile objects
byte[]	getFileData() Gets the byte array that represents the content of the file
String	getName() Gets the name of the file
boolean	getOverwrite() Gets the overwrite property for an SdlFile by default its set to false
int	getResourceId() Gets the resource id of the file
FileType	getType() Gets the type of the file
Uri	getUri() Gets the uri of the file
int	hashCode() Used to compile hashcode for SdlFile for use to compare in overridden equals method
boolean	isPersistent() Gets whether the file should persist between sessions / ignition cycles
boolean	isStaticIcon() Gets the the name of the static file.
void	setFileData(byte[] data) Sets the byte array that represents the content of the file
void	setName(String fileName) Sets the name of the file
void	setOverwrite(boolean overwrite) Sets the overwrite property for an SdlFile by default its set to false
void	setPersistent(boolean persistentFile) Sets whether the file should persist between sessions / ignition cycles
void	setResourceId(int id) Sets the resource ID of the file
void	setStaticIcon(boolean staticIcon) Sets the the name of the static file.
void	setType(FileType fileType) Sets the type of the file
void	setUri(Uri uri) Sets the uri of the file

Methods inherited from class java.lang.Object

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

Constructor Detail

SdlFile

public SdlFile()

Creates a new instance of SdlFile

SdlFile

public SdlFile(String fileName,
               @NonNull
               FileType fileType,
               int id,
               boolean persistentFile)

Creates a new instance of SdlFile

Parameters:

fileName - a String value representing the name that will be used to store the file in the head unit. You can pass null if you want the library to auto generate the name

fileType - a FileType enum value representing the type of the file

id - an int value representing the android resource id of the file

persistentFile - a boolean value that indicates if the file is meant to persist between sessions / ignition cycles

SdlFile

public SdlFile(String fileName,
               @NonNull
               FileType fileType,
               Uri uri,
               boolean persistentFile)

Creates a new instance of SdlFile

Parameters:

fileName - a String value representing the name that will be used to store the file in the head unit. You can pass null if you want the library to auto generate the name

fileType - a FileType enum value representing the type of the file

uri - a URI value representing a file's location. Currently, it only supports local files

persistentFile - a boolean value that indicates if the file is meant to persist between sessions / ignition cycles

SdlFile

public SdlFile(String fileName,
               @NonNull
               FileType fileType,
               byte[] data,
               boolean persistentFile)

Creates a new instance of SdlFile

Parameters:

fileName - a String value representing the name that will be used to store the file in the head unit. You can pass null if you want the library to auto generate the name

fileType - a FileType enum value representing the type of the file

data - a byte array representing the data of the file

persistentFile - a boolean value that indicates if the file is meant to persist between sessions / ignition cycles

SdlFile

public SdlFile(@NonNull
               StaticIconName staticIconName)

Creates a new instance of SdlFile

Parameters:

staticIconName - a StaticIconName enum value representing the name of a static file that comes pre-shipped with the head unit

Method Detail

setName

public void setName(String fileName)

Sets the name of the file

Parameters:

fileName - a String value representing the name that will be used to store the file in the head unit. You can pass null if you want the library to auto generate the name

getName

public String getName()

Gets the name of the file

Returns:

a String value representing the name that will be used to store the file in the head unit

setResourceId

public void setResourceId(int id)

Sets the resource ID of the file

Parameters:

id - an int value representing the android resource id of the file

getResourceId

public int getResourceId()

Gets the resource id of the file

Returns:

an int value representing the android resource id of the file

setUri

public void setUri(Uri uri)

Sets the uri of the file

Parameters:

uri - a URI value representing a file's location. Currently, it only supports local files

getUri

public Uri getUri()

Gets the uri of the file

Returns:

a URI value representing a file's location. Currently, it only supports local files

setFileData

public void setFileData(byte[] data)

Sets the byte array that represents the content of the file

Parameters:

data - a byte array representing the data of the file

getFileData

public byte[] getFileData()

Gets the byte array that represents the content of the file

Returns:

a byte array representing the data of the file

setType

public void setType(@NonNull
                    FileType fileType)

Sets the type of the file

Parameters:

fileType - a FileType enum value representing the type of the file

getType

public FileType getType()

Gets the type of the file

Returns:

a FileType enum value representing the type of the file

setPersistent

public void setPersistent(boolean persistentFile)

Sets whether the file should persist between sessions / ignition cycles

Parameters:

persistentFile - a boolean value that indicates if the file is meant to persist between sessions / ignition cycles

isPersistent

public boolean isPersistent()

Gets whether the file should persist between sessions / ignition cycles

Returns:

a boolean value that indicates if the file is meant to persist between sessions / ignition cycles

setStaticIcon

public void setStaticIcon(boolean staticIcon)

Sets the the name of the static file. Static files comes pre-shipped with the head unit

Parameters:

staticIcon - a StaticIconName enum value representing the name of a static file that comes pre-shipped with the head unit

isStaticIcon

public boolean isStaticIcon()

Gets the the name of the static file. Static files comes pre-shipped with the head unit

Returns:

a StaticIconName enum value representing the name of a static file that comes pre-shipped with the head unit

getOverwrite

public boolean getOverwrite()

Gets the overwrite property for an SdlFile by default its set to false

Returns:

a boolean value that indicates if a file can be overwritten.

setOverwrite

public void setOverwrite(boolean overwrite)

Sets the overwrite property for an SdlFile by default its set to false

Parameters:

overwrite - a boolean value that indicates if a file can be overwritten

hashCode

public int hashCode()

Used to compile hashcode for SdlFile for use to compare in overridden equals method

Overrides:

hashCode in class Object

Returns:

Custom hashcode of SdlFile variables

equals

public boolean equals(Object o)

Uses our custom hashCode for SdlFile objects

Overrides:

equals in class Object

Parameters:

o - - The object to compare

Returns:

boolean of whether the objects are the same or not

clone

public SdlFile clone()

Creates a deep copy of the object

Overrides:

clone in class Object

Returns:

deep copy of the object, null if an exception occurred