Package com._1c.g5.v8.dt.import_.xml.reader

Class XmlReaderResult

java.lang.Object

com._1c.g5.v8.dt.import_.xml.reader.XmlReaderResult

All Implemented Interfaces:

IXmlReadErrorCollector

Direct Known Subclasses:

ConfigurationXmlReaderResult, FormXmlReaderResult

public class XmlReaderResult
extends Object
implements IXmlReadErrorCollector

Data to return as result work of xml reader

Constructor Summary

Constructors

Constructor	Description
XmlReaderResult(Object resultObject)	Construct XmlReaderResult with result object

Method Summary

Modifier and Type	Method	Description
void	addAllErrorsFrom(IXmlReadErrorCollector errorCollector)	Copies all error messages from IXmlReadErrorCollector in this error collector.
void	addError(String message)	Adds error message to this error collector.
void	addError(org.eclipse.emf.ecore.EObject context, org.eclipse.emf.ecore.EStructuralFeature feature, IXmlNode node, String attributeName)	Adds error to this error collector, that was occurred during value read by the given node path.
void	addError(org.eclipse.emf.ecore.EObject context, org.eclipse.emf.ecore.EStructuralFeature feature, Object value, String attributeName, Exception e)	Adds error to this error collector, that was occurred during value set to model.
void	addUnreadElement(org.eclipse.emf.ecore.EStructuralFeature feature, IXmlNode nodes)	Add all names of object from xml nodes text content in list associate with feature.
void	addUnreadElement(org.eclipse.emf.ecore.EStructuralFeature feature, String name)	Add next name of object in list associate with feature.
void	addWarning(String message)	Adds warning message to this error collector.
org.eclipse.core.runtime.IStatus	convertToStatus(String pluginId)	Convert error messages of this result to IStatus
org.eclipse.core.runtime.IStatus	convertToStatus(String pluginId, String message)	Convert error messages of this result to IStatus
static XmlReaderResult	errorResult(String errorMessage)	Empty XmlReaderResult with one error message
static XmlReaderResult	errorResult(String errorMessageTemplate, Object... errorMessageArgs)	Empty XmlReaderResult with one error message
List<String>	getErrors()	Returns the list of error messages.
<T> T	getResultObject()	Get result object loaded from XML
Map<org.eclipse.emf.ecore.EStructuralFeature,List<String>>	getUnreadFeaturesMap()
List<String>	getUnreadNamesByFeature(org.eclipse.emf.ecore.EStructuralFeature feature)	Ordered list of object names
List<String>	getWarnings()	Returns the list of warning messages.
boolean	hasErrors()	Returns true if this collector has one or many error message, false otherwise.
boolean	hasWarnings()	Returns true if this collector has one or many warnings message, false otherwise.

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlReaderResult

public XmlReaderResult(Object resultObject)

Construct XmlReaderResult with result object

Parameters:

resultObject - the base result object what will load XML, or null if read result has only error(s)

Method Detail

errorResult

public static XmlReaderResult errorResult(String errorMessage)

Empty XmlReaderResult with one error message

Parameters:

errorMessage - the error message, cannot be null

errorResult

public static XmlReaderResult errorResult(String errorMessageTemplate,
                                          Object... errorMessageArgs)

Empty XmlReaderResult with one error message

Parameters:

errorMessageTemplate - a template for the error message, cannot be null

errorMessageArgs - the arguments to be substituted into the message template

See Also:

MessageFormat.format(String, Object...)

getResultObject

public <T> T getResultObject()

Get result object loaded from XML

Returns:

the object loaded from XML, can be null if an error occurred while reading

Throws:

ClassCastException - if unsuitable expected type of result object

getErrors

public List<String> getErrors()

Description copied from interface: IXmlReadErrorCollector

Returns the list of error messages.

Specified by:

getErrors in interface IXmlReadErrorCollector

Returns:

the list of error messages, never null

getWarnings

public List<String> getWarnings()

Description copied from interface: IXmlReadErrorCollector

Returns the list of warning messages.

Specified by:

getWarnings in interface IXmlReadErrorCollector

Returns:

the list of warning messages, never null

addError

public void addError(org.eclipse.emf.ecore.EObject context,
                     org.eclipse.emf.ecore.EStructuralFeature feature,
                     IXmlNode node,
                     String attributeName)

Description copied from interface: IXmlReadErrorCollector

Adds error to this error collector, that was occurred during value read by the given node path.

Specified by:

addError in interface IXmlReadErrorCollector

Parameters:

context - the context EObject, cannot be null

feature - the referenced EStructuralFeature, cannot be null

node - the xml node, cannot be null

attributeName - the attribute name, can be null if nodePath defines path to text in the given node

addError

public void addError(org.eclipse.emf.ecore.EObject context,
                     org.eclipse.emf.ecore.EStructuralFeature feature,
                     Object value,
                     String attributeName,
                     Exception e)

Description copied from interface: IXmlReadErrorCollector

Adds error to this error collector, that was occurred during value set to model.

Specified by:

addError in interface IXmlReadErrorCollector

Parameters:

context - the context EObject, cannot be null

feature - the referenced EStructuralFeature, cannot be null

value - the read Object}, can be null

attributeName - the attribute name, cannot be null

e - low-level exception, or null if not applicable

addError

public void addError(String message)

Description copied from interface: IXmlReadErrorCollector

Adds error message to this error collector.

Specified by:

addError in interface IXmlReadErrorCollector

Parameters:

message - the error message, cannot be null

addWarning

public void addWarning(String message)

Description copied from interface: IXmlReadErrorCollector

Adds warning message to this error collector.

Specified by:

addWarning in interface IXmlReadErrorCollector

Parameters:

message - the warning message, cannot be null

addAllErrorsFrom

public void addAllErrorsFrom(IXmlReadErrorCollector errorCollector)

Description copied from interface: IXmlReadErrorCollector

Copies all error messages from IXmlReadErrorCollector in this error collector.

Specified by:

addAllErrorsFrom in interface IXmlReadErrorCollector

Parameters:

errorCollector - the copy source, cannot be null

hasErrors

public boolean hasErrors()

Description copied from interface: IXmlReadErrorCollector

Returns true if this collector has one or many error message, false otherwise.

Specified by:

hasErrors in interface IXmlReadErrorCollector

Returns:

true if this collector has one or many error message, false otherwise

hasWarnings

public boolean hasWarnings()

Description copied from interface: IXmlReadErrorCollector

Returns true if this collector has one or many warnings message, false otherwise.

Specified by:

hasWarnings in interface IXmlReadErrorCollector

Returns:

true if this collector has one or many warnings message, false otherwise

getUnreadFeaturesMap

public Map<org.eclipse.emf.ecore.EStructuralFeature,List<String>> getUnreadFeaturesMap()

Returns:

Map contains pair of features to ordered list of object names what can by read in this work

addUnreadElement

public void addUnreadElement(org.eclipse.emf.ecore.EStructuralFeature feature,
                             String name)

Add next name of object in list associate with feature.

Use this method to save names and order of objects to be read later

Parameters:

feature - map key

name - of object to add in member list

addUnreadElement

public void addUnreadElement(org.eclipse.emf.ecore.EStructuralFeature feature,
                             IXmlNode nodes)

Add all names of object from xml nodes text content in list associate with feature.

Use this method to save names and order of objects to be read later

Parameters:

feature - map key

prefix - string while be concatenate with xml nodes text content

nodes - of object to add all in member list

getUnreadNamesByFeature

public List<String> getUnreadNamesByFeature(org.eclipse.emf.ecore.EStructuralFeature feature)

Ordered list of object names

Parameters:

feature - map key

Returns:

ordered list of object names

convertToStatus

public org.eclipse.core.runtime.IStatus convertToStatus(String pluginId)

Convert error messages of this result to IStatus

Parameters:

pluginId - the unique identifier of the relevant plug-in, cannot be null

Returns:

result IStatus, never null

convertToStatus

public org.eclipse.core.runtime.IStatus convertToStatus(String pluginId,
                                                        String message)

Convert error messages of this result to IStatus

Parameters:

pluginId - the unique identifier of the relevant plug-in, cannot be null

message - a human-readable message, localized to the current locale, can be null

Returns:

result IStatus, never null