com.qualcomm.ftccommon.configuration

Class RobotConfigFile

java.lang.Object

com.qualcomm.ftccommon.configuration.RobotConfigFile

public class RobotConfigFile
extends java.lang.Object

Metadata for a config file. If this is modified, then the Robocol version number needs to be bumped as this is shared via serialization with the DriverStation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RobotConfigFile.FileLocation

Constructor Summary

Constructors

Constructor and Description
RobotConfigFile(RobotConfigFileManager configFileManager, java.lang.String name)
RobotConfigFile(java.lang.String name, int resourceId)

Method Summary

Modifier and Type	Method and Description
boolean	containedIn(java.util.Collection<RobotConfigFile> configFiles)
static RobotConfigFile	fromString(RobotConfigFileManager configFileManager, java.lang.String serializedForm)
java.io.File	getFullPath()
RobotConfigFile.FileLocation	getLocation()
java.lang.String	getName()
int	getResourceId()
XmlPullParser	getXml()
protected XmlPullParser	getXmlLocalStorage()
protected XmlPullParser	getXmlNone()
protected XmlPullParser	getXmlResource()
boolean	isDirty()
boolean	isNoConfig()
boolean	isReadOnly()
void	markClean()
void	markDirty()
static RobotConfigFile	noConfig(RobotConfigFileManager configFileManager)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RobotConfigFile

public RobotConfigFile(RobotConfigFileManager configFileManager,
                       java.lang.String name)

RobotConfigFile

public RobotConfigFile(java.lang.String name,
                       int resourceId)

Method Detail

noConfig

public static RobotConfigFile noConfig(RobotConfigFileManager configFileManager)

isReadOnly

public boolean isReadOnly()

containedIn

public boolean containedIn(java.util.Collection<RobotConfigFile> configFiles)

markDirty

public void markDirty()

markClean

public void markClean()

isDirty

public boolean isDirty()

getName

public java.lang.String getName()

getFullPath

public java.io.File getFullPath()

getResourceId

public int getResourceId()

getLocation

public RobotConfigFile.FileLocation getLocation()

getXml

public XmlPullParser getXml()

getXmlNone

protected XmlPullParser getXmlNone()

getXmlLocalStorage

protected XmlPullParser getXmlLocalStorage()

getXmlResource

protected XmlPullParser getXmlResource()

isNoConfig

public boolean isNoConfig()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

fromString

public static RobotConfigFile fromString(RobotConfigFileManager configFileManager,
                                         java.lang.String serializedForm)