Package org.apache.maven.api.services.xml

Interface XmlFactory<T>

Type Parameters:

T - the object type to read/write

All Superinterfaces:

Service

All Known Subinterfaces:

ModelXmlFactory, SettingsXmlFactory, ToolchainsXmlFactory

All Known Implementing Classes:

DefaultModelXmlFactory, DefaultSettingsXmlFactory, DefaultToolchainsXmlFactory

@Experimental
public interface XmlFactory<T>
extends Service

Generic interface to read/write objects to/from XML.

Since:

4.0.0

Method Summary

Modifier and Type	Method	Description
default T	fromXmlString(String xml)	Simply parse the given xml string.
default T	read(InputStream input)
default T	read(InputStream input, boolean strict)
default T	read(Reader reader)
default T	read(Reader reader, boolean strict)
default T	read(Path path)
default T	read(Path path, boolean strict)
T	read(XmlReaderRequest request)
default String	toXmlString(T content)	Simply converts the given content to an xml string.
void	write(XmlWriterRequest<T> request)
default void	write(T content, OutputStream outputStream)
default void	write(T content, Writer writer)
default void	write(T content, Path path)

Method Details

read

@Nonnull
default T read(@Nonnull
 Path path)
        throws XmlReaderException

Throws:

XmlReaderException

read

@Nonnull
default T read(@Nonnull
 Path path,
 boolean strict)
        throws XmlReaderException

Throws:

XmlReaderException

read

@Nonnull
default T read(@Nonnull
 InputStream input)
        throws XmlReaderException

Throws:

XmlReaderException

read

@Nonnull
default T read(@Nonnull
 InputStream input,
 boolean strict)
        throws XmlReaderException

Throws:

XmlReaderException

read

@Nonnull
default T read(@Nonnull
 Reader reader)
        throws XmlReaderException

Throws:

XmlReaderException

read

@Nonnull
default T read(@Nonnull
 Reader reader,
 boolean strict)
        throws XmlReaderException

Throws:

XmlReaderException

read

@Nonnull
T read(@Nonnull
 XmlReaderRequest request)
throws XmlReaderException

Throws:

XmlReaderException

write

default void write(@Nonnull
 T content,
 @Nonnull
 Path path)
            throws XmlWriterException

Throws:

XmlWriterException

write

default void write(@Nonnull
 T content,
 @Nonnull
 OutputStream outputStream)
            throws XmlWriterException

Throws:

XmlWriterException

write

default void write(@Nonnull
 T content,
 @Nonnull
 Writer writer)
            throws XmlWriterException

Throws:

XmlWriterException

write

void write(@Nonnull
 XmlWriterRequest<T> request)
    throws XmlWriterException

Throws:

XmlWriterException

fromXmlString

@Nonnull
default T fromXmlString(@Nonnull
 String xml)
                 throws XmlReaderException

Simply parse the given xml string.

Parameters:

xml - the input xml string

Returns:

the parsed object

Throws:

XmlReaderException - if an error occurs during the parsing

See Also:

• toXmlString(Object)

toXmlString

@Nonnull
default String toXmlString(@Nonnull
 T content)
                    throws XmlWriterException

Simply converts the given content to an xml string.

Parameters:

content - the object to convert

Returns:

the xml string representation

Throws:

XmlWriterException - if an error occurs during the transformation

See Also:

• fromXmlString(String)