Modifier and Type	Class and Description
private static class	PropertyMapImpl.PropDef Helper for holding info about default properties
pack-priv static class	PropertyMapImpl.PropertyImpl Info about a property defined in a PropertyMap.

Modifier and Type	Field and Description
pack-priv static final byte	DDL_FLAG property flag bit for the DDL argument of the DAO CreateProperty method.
private static final Map<String, PropertyMapImpl.PropDef>	DEFAULT_TYPES
private final String	mapName
private final short	mapType
private final PropertyMaps	owner
private final Map<String, PropertyMap.Property>	props
pack-priv static final byte	SKIP_HANDLER_FLAG property flag bit which tells the engine to store the value without running the handler bound to the property name, so that writing the property records a state instead of bringing it about.

Access	Constructor and Description
public	PropertyMapImpl(String name, short type, PropertyMaps owner)

Method Summary

Modifier and Type	Method and Description
public static PropertyMap.Property	createProperty(String name, DataType type, Object value)
public static PropertyMap.Property	createProperty(String name, DataType type, Object value, boolean isDdl)
pack-priv static PropertyMap.Property	Returns: the new property createProperty(String property name name, DataType property type, or `null` to derive it from the default info or the value type, Object property value value, byte flag byte as stored in the file flags) Creates a property with the given flag byte as stored in the file.
public PropertyMap.Property	get(String name) Implements io.github.spannm.jackcess.PropertyMap.get. Returns the property with the given name, if any.
public String	getName() Implements io.github.spannm.jackcess.PropertyMap.getName. Returns the name of the database object to which this property map belongs.
public PropertyMaps	getOwner()
public int	getSize() Implements io.github.spannm.jackcess.PropertyMap.getSize. Returns the number of properties currently in this map.
public short	getType()
public Object	getValue(String name) Implements io.github.spannm.jackcess.PropertyMap.getValue. Returns the value of the property with the given name, if any.
public Object	getValue(String name, Object defaultValue) Implements io.github.spannm.jackcess.PropertyMap.getValue. Returns the value of the property with the given name, if any, otherwise the given defaultValue.
public boolean	isEmpty() Implements io.github.spannm.jackcess.PropertyMap.isEmpty. Returns `true` if this map has no properties.
public Iterator<PropertyMap.Property>	iterator() Implements java.lang.Iterable.iterator. Returns an iterator over elements of type `T`.
public PropertyMapImpl.PropertyImpl	put(String name, Object value) Implements io.github.spannm.jackcess.PropertyMap.put. Creates a new (or updates an existing) property in the map.
public PropertyMapImpl.PropertyImpl	put(String name, DataType type, Object value) Implements io.github.spannm.jackcess.PropertyMap.put. Creates a new (or updates an existing) property in the map.
public PropertyMapImpl.PropertyImpl	put(PropertyMap.Property prop)
public PropertyMapImpl.PropertyImpl	put(String name, DataType type, Object value, boolean isDdl) Implements io.github.spannm.jackcess.PropertyMap.put. Puts a property into this map with the given information.
pack-priv PropertyMapImpl.PropertyImpl	Returns: the new property put(String property name name, DataType property type type, Object property value value, byte flag byte as stored in the file flags) Puts a property into this map with the given flag byte as stored in the file.
public void	putAll(Iterable<? extends PropertyMap.Property> newProps) Implements io.github.spannm.jackcess.PropertyMap.putAll. Puts all the given properties into this map.
public PropertyMapImpl.PropertyImpl	remove(String name) Implements io.github.spannm.jackcess.PropertyMap.remove. Removes the property with the given name
public void	save() Implements io.github.spannm.jackcess.PropertyMap.save. Saves the current state of this map.
private static byte	Returns: the flag byte toFlags(boolean whether the property is a DDL property isDdl) Converts the given ddl state into a flag byte.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public static String	toString(PropertyMap map)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

DDL_FLAG	back to summary
pack-priv static final byte DDL_FLAG property flag bit for the DDL argument of the DAO CreateProperty method. A user cannot change or delete a DDL property without dbSecWriteDef permission

DEFAULT_TYPES	back to summary
private static final Map<String, PropertyMapImpl.PropDef> DEFAULT_TYPES

mapName	back to summary
private final String mapName

mapType	back to summary
private final short mapType

owner	back to summary
private final PropertyMaps owner

props	back to summary
private final Map<String, PropertyMap.Property> props

SKIP_HANDLER_FLAG	back to summary
pack-priv static final byte SKIP_HANDLER_FLAG property flag bit which tells the engine to store the value without running the handler bound to the property name, so that writing the property records a state instead of bringing it about. The engine sets it on its own account and no DAO call produces it

Constructor Detail

PropertyMapImpl	back to summary
public PropertyMapImpl(String name, short type, PropertyMaps owner)

Method Detail

createProperty	back to summary
public static PropertyMap.Property createProperty(String name, DataType type, Object value)

createProperty	back to summary
public static PropertyMap.Property createProperty(String name, DataType type, Object value, boolean isDdl)

createProperty back to summary

createProperty	back to summary
pack-priv static PropertyMap.Property createProperty(String name, DataType type, Object value, byte flags) Creates a property with the given flag byte as stored in the file. Parameters name:String property name type:DataType property type, or `null` to derive it from the default info or the value value:Object property value flags:byte flag byte as stored in the file Returns:PropertyMap.Property the new property

pack-priv static PropertyMap.Property createProperty(String name, DataType type, Object value, byte flags)

Creates a property with the given flag byte as stored in the file.

Parameters

name:String: property name
type:DataType: property type, or null to derive it from the default info or the value
value:Object: property value
flags:byte: flag byte as stored in the file

Returns:PropertyMap.Property

the new property

get	back to summary
public PropertyMap.Property get(String name) Implements io.github.spannm.jackcess.PropertyMap.get. Doc from io.github.spannm.jackcess.PropertyMap.get. Returns the property with the given name, if any. Annotations @Override

get

back to summary

public PropertyMap.Property get(String name)

Implements io.github.spannm.jackcess.PropertyMap.get.

Doc from io.github.spannm.jackcess.PropertyMap.get.

Returns the property with the given name, if any.

Annotations

@Override

getName	back to summary
public String getName() Implements io.github.spannm.jackcess.PropertyMap.getName. Doc from io.github.spannm.jackcess.PropertyMap.getName. Returns the name of the database object to which this property map belongs. Annotations @Override

getName

back to summary

public String getName()

Implements io.github.spannm.jackcess.PropertyMap.getName.

Doc from io.github.spannm.jackcess.PropertyMap.getName.

Returns the name of the database object to which this property map belongs.

Annotations

@Override

getOwner	back to summary
public PropertyMaps getOwner()

getSize	back to summary
public int getSize() Implements io.github.spannm.jackcess.PropertyMap.getSize. Doc from io.github.spannm.jackcess.PropertyMap.getSize. Returns the number of properties currently in this map. Annotations @Override

getSize

back to summary

public int getSize()

Implements io.github.spannm.jackcess.PropertyMap.getSize.

Doc from io.github.spannm.jackcess.PropertyMap.getSize.

Returns the number of properties currently in this map.

Annotations

@Override

getType	back to summary
public short getType()

getValue	back to summary
public Object getValue(String name) Implements io.github.spannm.jackcess.PropertyMap.getValue. Doc from io.github.spannm.jackcess.PropertyMap.getValue. Returns the value of the property with the given name, if any. Annotations @Override

getValue

back to summary

public Object getValue(String name)

Implements io.github.spannm.jackcess.PropertyMap.getValue.

Doc from io.github.spannm.jackcess.PropertyMap.getValue.

Returns the value of the property with the given name, if any.

Annotations

@Override

getValue	back to summary
public Object getValue(String name, Object defaultValue) Implements io.github.spannm.jackcess.PropertyMap.getValue. Doc from io.github.spannm.jackcess.PropertyMap.getValue. Returns the value of the property with the given name, if any, otherwise the given defaultValue. Annotations @Override

getValue

back to summary

public Object getValue(String name, Object defaultValue)

Implements io.github.spannm.jackcess.PropertyMap.getValue.

Doc from io.github.spannm.jackcess.PropertyMap.getValue.

Returns the value of the property with the given name, if any, otherwise the given defaultValue.

Annotations

@Override

isEmpty back to summary

isEmpty	back to summary
public boolean isEmpty() Implements io.github.spannm.jackcess.PropertyMap.isEmpty. Doc from io.github.spannm.jackcess.PropertyMap.isEmpty. Returns `true` if this map has no properties. Annotations @Override

public boolean isEmpty()

Implements io.github.spannm.jackcess.PropertyMap.isEmpty.

Doc from io.github.spannm.jackcess.PropertyMap.isEmpty.

Returns true if this map has no properties.

Annotations

@Override

iterator back to summary

iterator	back to summary
public Iterator<PropertyMap.Property> iterator() Implements java.lang.Iterable.iterator. Doc from java.lang.Iterable.iterator. Returns an iterator over elements of type `T`. Annotations @Override

public Iterator<PropertyMap.Property> iterator()

Implements java.lang.Iterable.iterator.

Doc from java.lang.Iterable.iterator.

Returns an iterator over elements of type T.

Annotations

@Override

put back to summary

put	back to summary
public PropertyMapImpl.PropertyImpl put(String name, Object value) Implements io.github.spannm.jackcess.PropertyMap.put. Doc from io.github.spannm.jackcess.PropertyMap.put. Creates a new (or updates an existing) property in the map. Attempts to determine the type of the property based on the name and value (the property names listed above have their types builtin, otherwise the type of the value is used). Note, this change will not be persisted until the `save` method has been called. Annotations @Override

public PropertyMapImpl.PropertyImpl put(String name, Object value)

Implements io.github.spannm.jackcess.PropertyMap.put.

Doc from io.github.spannm.jackcess.PropertyMap.put.

Creates a new (or updates an existing) property in the map. Attempts to determine the type of the property based on the name and value (the property names listed above have their types builtin, otherwise the type of the value is used).

Note, this change will not be persisted until the save method has been called.

Annotations

@Override

put back to summary

put	back to summary
public PropertyMapImpl.PropertyImpl put(String name, DataType type, Object value) Implements io.github.spannm.jackcess.PropertyMap.put. Doc from io.github.spannm.jackcess.PropertyMap.put. Creates a new (or updates an existing) property in the map. Note, this change will not be persisted until the `save` method has been called. Annotations @Override

public PropertyMapImpl.PropertyImpl put(String name, DataType type, Object value)

Implements io.github.spannm.jackcess.PropertyMap.put.

Doc from io.github.spannm.jackcess.PropertyMap.put.

Creates a new (or updates an existing) property in the map.

Note, this change will not be persisted until the save method has been called.

Annotations

@Override

put	back to summary
public PropertyMapImpl.PropertyImpl put(PropertyMap.Property prop)

put	back to summary
public PropertyMapImpl.PropertyImpl put(String name, DataType type, Object value, boolean isDdl) Implements io.github.spannm.jackcess.PropertyMap.put. Puts a property into this map with the given information. Annotations @Override

put

back to summary

public PropertyMapImpl.PropertyImpl put(String name, DataType type, Object value, boolean isDdl)

Implements io.github.spannm.jackcess.PropertyMap.put.

Puts a property into this map with the given information.

Annotations

@Override

put	back to summary
pack-priv PropertyMapImpl.PropertyImpl put(String name, DataType type, Object value, byte flags) Puts a property into this map with the given flag byte as stored in the file. Parameters name:String property name type:DataType property type value:Object property value flags:byte flag byte as stored in the file Returns:PropertyMapImpl.PropertyImpl the new property

put

back to summary

pack-priv PropertyMapImpl.PropertyImpl put(String name, DataType type, Object value, byte flags)

Puts a property into this map with the given flag byte as stored in the file.

Parameters

name:String: property name
type:DataType: property type
value:Object: property value
flags:byte: flag byte as stored in the file

Returns:PropertyMapImpl.PropertyImpl

the new property

putAll	back to summary
public void putAll(Iterable<? extends PropertyMap.Property> newProps) Implements io.github.spannm.jackcess.PropertyMap.putAll. Doc from io.github.spannm.jackcess.PropertyMap.putAll. Puts all the given properties into this map. Annotations @Override

putAll

back to summary

public void putAll(Iterable<? extends PropertyMap.Property> newProps)

Implements io.github.spannm.jackcess.PropertyMap.putAll.

Doc from io.github.spannm.jackcess.PropertyMap.putAll.

Puts all the given properties into this map.

Annotations

@Override

remove	back to summary
public PropertyMapImpl.PropertyImpl remove(String name) Implements io.github.spannm.jackcess.PropertyMap.remove. Doc from io.github.spannm.jackcess.PropertyMap.remove. Removes the property with the given name Annotations @Override

remove

back to summary

public PropertyMapImpl.PropertyImpl remove(String name)

Implements io.github.spannm.jackcess.PropertyMap.remove.

Doc from io.github.spannm.jackcess.PropertyMap.remove.

Removes the property with the given name

Annotations

@Override

save	back to summary
public void save() throws IOException Implements io.github.spannm.jackcess.PropertyMap.save. Doc from io.github.spannm.jackcess.PropertyMap.save. Saves the current state of this map. Annotations @Override

save

back to summary

public void save() throws IOException

Implements io.github.spannm.jackcess.PropertyMap.save.

Doc from io.github.spannm.jackcess.PropertyMap.save.

Saves the current state of this map.

Annotations

@Override

toFlags	back to summary
private static byte toFlags(boolean isDdl) Converts the given ddl state into a flag byte. Parameters isDdl:boolean whether the property is a DDL property Returns:byte the flag byte

toFlags

back to summary

private static byte toFlags(boolean isDdl)

Converts the given ddl state into a flag byte.

Parameters

isDdl:boolean: whether the property is a DDL property

Returns:byte

the flag byte

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

toString	back to summary
public static String toString(PropertyMap map)

io.github.spannm.jackcess.impl back to summary

private final Class PropertyMapImpl.PropDef

Class Inheritance

extends Object

java.lang.Object
io.github.spannm.jackcess.impl.PropertyMapImpl.PropDef

Helper for holding info about default properties

Field Summary

Modifier and Type	Field and Description
private final boolean	isDdl
private final DataType	type

Constructor Summary

Access	Constructor and Description
private	PropDef(DataType type, boolean isDdl)

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

isDdl	back to summary
private final boolean isDdl

type	back to summary
private final DataType type

Constructor Detail

PropDef	back to summary
private PropDef(DataType type, boolean isDdl)

io.github.spannm.jackcess.impl back to summary

pack-priv final Class PropertyMapImpl.PropertyImpl

Class Inheritance

extends Object
implements Property

java.lang.Object
io.github.spannm.jackcess.impl.PropertyMapImpl.PropertyImpl

All Implemented Interfaces

io.github.spannm.jackcess.PropertyMap.Property

Info about a property defined in a PropertyMap.

Field Summary

Modifier and Type	Field and Description
private final byte	flags the flag byte exactly as it is stored in the file
private final String	name
private final DataType	type
private Object	value

Constructor Summary

Access	Constructor and Description
private	PropertyImpl(String name, DataType type, Object value, byte flags)

Method Summary

Modifier and Type	Method and Description
pack-priv byte	Returns: the flag byte getFlags() Returns the flag byte as stored in the file.
public String	getName() Implements io.github.spannm.jackcess.PropertyMap.Property.getName. Returns the name of this property.
public DataType	getType() Implements io.github.spannm.jackcess.PropertyMap.Property.getType. Returns the data type of this property's value.
public Object	getValue() Implements io.github.spannm.jackcess.PropertyMap.Property.getValue. Returns the current value of this property.
public boolean	isDdl() Implements io.github.spannm.jackcess.PropertyMap.Property.isDdl. Whether or not this property is a DDL object.
public void	setValue(Object newValue) Implements io.github.spannm.jackcess.PropertyMap.Property.setValue. Sets the new value for this property.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

flags	back to summary
private final byte flags the flag byte exactly as it is stored in the file

name	back to summary
private final String name

type	back to summary
private final DataType type

value	back to summary
private Object value

Constructor Detail

PropertyImpl	back to summary
private PropertyImpl(String name, DataType type, Object value, byte flags)

Method Detail

getFlags back to summary

getFlags	back to summary
pack-priv byte getFlags() Returns the flag byte as stored in the file. Access uses more of it than the one bit `isDdl` reports, so the whole byte has to be written back unchanged. Returns:byte the flag byte

pack-priv byte getFlags()

Returns the flag byte as stored in the file. Access uses more of it than the one bit isDdl reports, so the whole byte has to be written back unchanged.

Returns:byte: the flag byte

getName	back to summary
public String getName() Implements io.github.spannm.jackcess.PropertyMap.Property.getName. Doc from io.github.spannm.jackcess.PropertyMap.Property.getName. Returns the name of this property. Annotations @Override

getName

back to summary

public String getName()

Implements io.github.spannm.jackcess.PropertyMap.Property.getName.

Doc from io.github.spannm.jackcess.PropertyMap.Property.getName.

Returns the name of this property.

Annotations

@Override

getType

back to summary

public DataType getType()

Implements io.github.spannm.jackcess.PropertyMap.Property.getType.

Doc from io.github.spannm.jackcess.PropertyMap.Property.getType.

Returns the data type of this property's value.

Annotations

@Override

getValue

back to summary

public Object getValue()

Implements io.github.spannm.jackcess.PropertyMap.Property.getValue.

Doc from io.github.spannm.jackcess.PropertyMap.Property.getValue.

Returns the current value of this property.

Annotations

@Override

isDdl back to summary

public boolean isDdl()

Implements io.github.spannm.jackcess.PropertyMap.Property.isDdl.

Doc from io.github.spannm.jackcess.PropertyMap.Property.isDdl.

Whether or not this property is a DDL object. If true, users can't change or delete the property in access without the dbSecWriteDef permission. Additionally, certain properties must be flagged correctly or the access engine may not recognize them correctly.

Annotations