casa.io

Class CASAFileLACKnownUsersMap

java.lang.Object

casa.util.UserMap

casa.util.UserMapXML

casa.io.CASAFileLACKnownUsersMap

public class CASAFileLACKnownUsersMap
extends UserMapXML

Copyright: Copyright 2003-2014, Knowledge Science Group, University of Calgary. Permission to use, copy, modify, distribute and sell this software and its documentation for any purpose is hereby granted without fee, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation. The Knowledge Science Group makes no representations about the suitability of this software for any purpose. It is provided "as is" without express or implied warranty.

Version:

0.9

Author:

Rob Kremer

Field Summary

Fields

Modifier and Type	Field and Description
private CASAFile	file The CASAFile that we are writing these properties to.
private boolean	initializing Determines whther the file has been initialized to what we beleive to be a correct value.
private boolean	keepFileUpdated Determines whether the properties are automatically written when they are changed.
static String	PROPERTIES_SECURITY_ENTRY

Fields inherited from class casa.util.UserMapXML

modified, PROPERTY_TYPE, STRING_TYPE

Constructor Summary

Constructors

Constructor and Description
CASAFileLACKnownUsersMap(CASAFile file)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object object) Compares the specified Object with this CASAFilePropertiesMap for equality.
boolean	getKeepFileUpdated() Returns whether this object is set to keep the file updated with every property change.
void	setKeepFileUpdated(boolean keepUpdated) Sets whether this object is to keep the file updated with every property change.
protected void	setModified() Called when the XML is modified for any reason.
void	writeSecurityProperties() Writes the propreties to the CASAFile.

Methods inherited from class casa.util.UserMapXML

clone, isModified, read, read, read, removeProperty, resetModified, setAllProperties, setProperty, setString, toString, write, write

Methods inherited from class casa.util.UserMap

clearProperties, getProperties, getProperty, getString, getType, hasProperty

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PROPERTIES_SECURITY_ENTRY

public static String PROPERTIES_SECURITY_ENTRY

file

private CASAFile file

The CASAFile that we are writing these properties to.

initializing

private boolean initializing

Determines whther the file has been initialized to what we beleive to be a correct value. true if the file has not been set yet; false otherwise.

keepFileUpdated

private boolean keepFileUpdated

Determines whether the properties are automatically written when they are changed.

Constructor Detail

CASAFileLACKnownUsersMap

public CASAFileLACKnownUsersMap(CASAFile file)

Method Detail

writeSecurityProperties

public void writeSecurityProperties()

Writes the propreties to the CASAFile.

setKeepFileUpdated

public void setKeepFileUpdated(boolean keepUpdated)

Sets whether this object is to keep the file updated with every property change.

Parameters:

keepUpdated - true if the object is set to keep the file updated with every property change; false otherwise.

getKeepFileUpdated

public boolean getKeepFileUpdated()

Returns whether this object is set to keep the file updated with every property change.

Returns:

true if the object is set to keep the file updated with every property change; false otherwise.

setModified

protected void setModified()

Called when the XML is modified for any reason. This overrides the super-class method so that the properties are written automatically if keepFileUpdated is set.

Overrides:

setModified in class UserMapXML

equals

public boolean equals(Object object)

Compares the specified Object with this CASAFilePropertiesMap for equality. The two are equal if the Object is an instance of PropertiesMap and all of their properties are equal, and furthermore, if the Object is an instance of CASAFilePropertiesMap, they must both use the same CASAFile.

Overrides:

equals in class UserMap

Parameters:

object - The Object to be compared for equality with this CASAFilePropertiesMap.

Returns:

true if the specified Object is equal to this CASAFilePropertiesMap; false otherwise.