Index
All Classes and Interfaces|All Packages|Serialized Form
A
- Attribute<EnclosingType,
EnclosingBean, - Class in io.kojan.xmlAttributeType> -
Attribute of an
Entity
. - Attribute(String, Getter<EnclosingType, Iterable<AttributeType>>, Setter<EnclosingBean, AttributeType>, Converter<AttributeType, String>, Converter<String, AttributeType>, boolean, boolean) - Constructor for class io.kojan.xml.Attribute
-
Creates an attribute of an entity.
B
- build() - Method in interface io.kojan.xml.Builder
-
Builds an object out of captured state.
- Builder<Type> - Interface in io.kojan.xml
-
An object builder.
C
- convert(SourceType) - Method in interface io.kojan.xml.Converter
-
Converts objects of one type into objects of another type.
- Converter<SourceType,
TargetType> - Interface in io.kojan.xml -
Converter function.
D
- dump(XMLDumper, AttributeType) - Method in class io.kojan.xml.Attribute
- dump(XMLDumper, NestedType) - Method in class io.kojan.xml.Property
-
Serializes the property into XML format, using given
XMLDumper
. - dump(XMLDumper, RelatedType) - Method in class io.kojan.xml.Relationship
- dumpEndElement() - Method in interface io.kojan.xml.XMLDumper
-
Writes a sequence that ends previously started XML element.
- dumpEntity(Entity<Type, Bean>, Type) - Method in interface io.kojan.xml.XMLDumper
-
Serializes given
Entity
into XML form. - dumpStartElement(String) - Method in interface io.kojan.xml.XMLDumper
-
Writes a sequence that starts an XML element with given tag.
- dumpText(String) - Method in interface io.kojan.xml.XMLDumper
-
Writes XML text content.
E
- Entity<Type,
Bean> - Class in io.kojan.xml -
An entity type.
- Entity(String, Factory<Bean>, Converter<Bean, Type>, List<Property<Type, Bean, ?>>) - Constructor for class io.kojan.xml.Entity
-
Creates an entity.
F
- Factory<Type> - Interface in io.kojan.xml
-
A factory of beans of given type.
- fromXML(String) - Method in class io.kojan.xml.Entity
-
Deserializes entity from XML format.
G
- get(OuterType) - Method in interface io.kojan.xml.Getter
-
Returns the value of bean property.
- getBeanConverter() - Method in class io.kojan.xml.Entity
-
Obtains a converter function that converts entity bean to entity object.
- getBeanFactory() - Method in class io.kojan.xml.Entity
-
Obtains a factory used to create initial entity bean.
- getGetter() - Method in class io.kojan.xml.Property
-
Obtain property getter method that can be used to retrieve property value.
- getProperties() - Method in class io.kojan.xml.Entity
-
Get entity properties, such as attributes, relationships and other custom properties.
- getSetter() - Method in class io.kojan.xml.Property
-
Obtain property setter method that can be used to update property value.
- getTag() - Method in class io.kojan.xml.Entity
-
Determines XML element tag name used to serialize the entity in XML form.
- getTag() - Method in class io.kojan.xml.Property
-
Determines XML element tag name used to serialize the property in XML form.
- Getter<OuterType,
NestedType> - Interface in io.kojan.xml -
Bean property getter.
H
- hasStartElement() - Method in interface io.kojan.xml.XMLParser
-
Determines whether at the current parser position there is an XML element opening tag.
- hasStartElement(String) - Method in interface io.kojan.xml.XMLParser
-
Determines whether at the current parser position there is an XML element opening tag with specified tag name.
I
- io.kojan.xml - package io.kojan.xml
-
A simple library for modeling and writing data in XML format.
- isOptional() - Method in class io.kojan.xml.Property
-
Determines whether the property is optional or not.
- isUnique() - Method in class io.kojan.xml.Property
-
Determines whether the property is unique or not.
N
- newInstance() - Method in interface io.kojan.xml.Factory
-
Creates a bean instance.
- nop(Type) - Static method in interface io.kojan.xml.Converter
-
No operation converter that converts object to itself.
O
- of(Entity<RelatedType, RelatedBean>, Getter<Type, Iterable<RelatedType>>, Setter<Bean, RelatedType>) - Static method in class io.kojan.xml.Relationship
-
Creates a non-unique, optional relationship with another entity.
- of(String, Factory<Bean>, Converter<Bean, Type>, Property<Type, Bean, ?>...) - Static method in class io.kojan.xml.Entity
-
Creates an entity using a converter method for converting entity beans to entity objects.
- of(String, Factory<Bean>, Property<Type, Bean, ?>...) - Static method in class io.kojan.xml.Entity
-
Creates an entity using a bean class implementing the
Builder
interface. - of(String, Getter<Type, AttributeType>, Setter<Bean, AttributeType>, Converter<AttributeType, String>, Converter<String, AttributeType>) - Static method in class io.kojan.xml.Attribute
-
Creates a unique, non-optional attribute.
- of(String, Getter<Type, String>, Setter<Bean, String>) - Static method in class io.kojan.xml.Attribute
-
Creates a unique, non-optional String attribute.
- ofMulti(String, Getter<Type, Iterable<AttributeType>>, Setter<Bean, AttributeType>, Converter<AttributeType, String>, Converter<String, AttributeType>) - Static method in class io.kojan.xml.Attribute
-
Creates a non-unique, optional attribute.
- ofMulti(String, Getter<Type, Iterable<String>>, Setter<Bean, String>) - Static method in class io.kojan.xml.Attribute
-
Creates a non-unique, optional String attribute.
- ofMutable(String, Factory<Type>, Property<Type, Type, ?>...) - Static method in class io.kojan.xml.Entity
-
Creates an entity over a mutable data type that does not need conversion from bean type.
- ofOptional(String, Getter<Type, AttributeType>, Setter<Bean, AttributeType>, Converter<AttributeType, String>, Converter<String, AttributeType>) - Static method in class io.kojan.xml.Attribute
-
Creates a unique, optional attribute.
- ofOptional(String, Getter<Type, String>, Setter<Bean, String>) - Static method in class io.kojan.xml.Attribute
-
Creates a unique, optional String attribute.
- ofSingular(Entity<RelatedType, RelatedBean>, Getter<Type, RelatedType>, Setter<Bean, RelatedType>) - Static method in class io.kojan.xml.Relationship
-
Creates a unique, optional relationship with another entity.
P
- parse(XMLParser) - Method in class io.kojan.xml.Attribute
- parse(XMLParser) - Method in class io.kojan.xml.Property
-
Deserializes the property from XML format, using given
XMLParser
. - parse(XMLParser) - Method in class io.kojan.xml.Relationship
- parseEndElement(String) - Method in interface io.kojan.xml.XMLParser
-
Reads XML element closing tag with specified tag name.
- parseEntity(Entity<Type, Bean>, Bean) - Method in interface io.kojan.xml.XMLParser
-
Deserializes given
Entity
from XML form. - parseStartElement() - Method in interface io.kojan.xml.XMLParser
-
Reads XML element opening tag.
- parseStartElement(String) - Method in interface io.kojan.xml.XMLParser
-
Reads XML element opening tag with specified tag name.
- parseText() - Method in interface io.kojan.xml.XMLParser
-
Reads XML text content.
- Property<EnclosingType,
EnclosingBean, - Class in io.kojan.xmlNestedType> -
Property of data
Entity
. - Property(String, Getter<EnclosingType, Iterable<NestedType>>, Setter<EnclosingBean, NestedType>, boolean, boolean) - Constructor for class io.kojan.xml.Property
-
Initializes the abstract property.
R
- readFromXML(Reader) - Method in class io.kojan.xml.Entity
-
Deserializes entity from XML format, reading XML data from given
Reader
. - readFromXML(Path) - Method in class io.kojan.xml.Entity
-
Deserializes entity from XML format, reading XML data from file at given
Path
. - Relationship<EnclosingType,
EnclosingBean, - Class in io.kojan.xmlRelatedType, RelatedBean> -
Relationship of one
Entity
type to another. - Relationship(Entity<RelatedType, RelatedBean>, Getter<EnclosingType, Iterable<RelatedType>>, Setter<EnclosingBean, RelatedType>, boolean, boolean) - Constructor for class io.kojan.xml.Relationship
-
Creates a relationship between two entities.
S
- set(OuterType, NestedType) - Method in interface io.kojan.xml.Setter
-
Updates value of bean property.
- Setter<OuterType,
NestedType> - Interface in io.kojan.xml -
Bean property setter.
T
- toXML(Type) - Method in class io.kojan.xml.Entity
-
Serializes entity into XML format.
W
- writeToXML(Writer, Type) - Method in class io.kojan.xml.Entity
-
Serializes entity into XML format, writing XML data to given
Writer
. - writeToXML(Path, Type) - Method in class io.kojan.xml.Entity
-
Serializes entity into XML format, writing XML data to file at given
Path
.
X
- XMLDumper - Interface in io.kojan.xml
-
A facility to serialize data in in XML format.
- XMLException - Exception Class in io.kojan.xml
-
Indicates an exception that occurred during XML serialization or deserialization, such as malformed XML or XML not conforming to the expected schema.
- XMLException(String) - Constructor for exception class io.kojan.xml.XMLException
-
Constructs a new XML exception with the specified detail message and no cause.
- XMLException(String, Throwable) - Constructor for exception class io.kojan.xml.XMLException
-
Constructs a new XML exception with the specified detail message and cause.
- XMLException(Throwable) - Constructor for exception class io.kojan.xml.XMLException
-
Constructs a new XML exception with the specified cause and no detail message.
- XMLParser - Interface in io.kojan.xml
-
A facility to deserialize data in in XML format.
All Classes and Interfaces|All Packages|Serialized Form