eu.toop.edm.xml.IJAXBVersatileWriter Maven / Gradle / Ivy
/**
* This work is protected under copyrights held by the members of the
* TOOP Project Consortium as indicated at
* http://wiki.ds.unipi.gr/display/TOOP/Contributors
* (c) 2018-2021. All rights reserved.
*
* This work is dual licensed under Apache License, Version 2.0
* and the EUPL 1.2.
*
* = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =
*
* Licensed under the EUPL, Version 1.2 or – as soon they will be approved
* by the European Commission - subsequent versions of the EUPL
* (the "Licence");
* You may not use this work except in compliance with the Licence.
* You may obtain a copy of the Licence at:
*
* https://joinup.ec.europa.eu/software/page/eupl
*/
package eu.toop.edm.xml;
import java.io.File;
import java.io.OutputStream;
import java.io.Writer;
import java.nio.BufferOverflowException;
import java.nio.ByteBuffer;
import java.nio.file.Path;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.WillClose;
import javax.xml.transform.Result;
import org.w3c.dom.Document;
import com.helger.commons.io.resource.IWritableResource;
import com.helger.commons.io.stream.NonBlockingByteArrayInputStream;
import com.helger.commons.state.ESuccess;
import com.helger.jaxb.IJAXBWriter;
import com.helger.jaxb.IJAXBWriter.IJAXBMarshaller;
import com.helger.xml.microdom.IMicroDocument;
import com.helger.xml.microdom.IMicroElement;
import com.helger.xml.serialize.write.SafeXMLStreamWriter;
/**
* Default implementation of {@link IVersatileWriter} based on
* {@link IJAXBWriter}.
*
* @author Philip Helger
* @param
* Type to be written.
*/
public interface IJAXBVersatileWriter extends IVersatileWriter
{
/**
* @return The object to write. May not be null.
*/
@Nonnull
T getObjectToWrite ();
/**
* @return The JAXB writer to use. May not be null.
*/
@Nonnull
IJAXBWriter getWriter ();
/**
* Write the passed object to a {@link File}.
*
* @param aResultFile
* The result file to be written to. May not be null.
* @return {@link ESuccess}
*/
@Nonnull
default ESuccess write (@Nonnull final File aResultFile)
{
return getWriter ().write (getObjectToWrite (), aResultFile);
}
/**
* Write the passed object to a {@link Path}.
*
* @param aResultPath
* The result path to be written to. May not be null.
* @return {@link ESuccess}
*/
@Nonnull
default ESuccess write (@Nonnull final Path aResultPath)
{
return getWriter ().write (getObjectToWrite (), aResultPath);
}
/**
* Write the passed object to an {@link OutputStream}.
*
* @param aOS
* The output stream to write to. Will always be closed. May not be
* null.
* @return {@link ESuccess}
*/
@Nonnull
default ESuccess write (@Nonnull @WillClose final OutputStream aOS)
{
return getWriter ().write (getObjectToWrite (), aOS);
}
/**
* Write the passed object to a {@link Writer}.
*
* @param aWriter
* The writer to write to. Will always be closed. May not be
* null.
* @return {@link ESuccess}
*/
@Nonnull
default ESuccess write (@Nonnull @WillClose final Writer aWriter)
{
return getWriter ().write (getObjectToWrite (), aWriter);
}
/**
* Write the passed object to a {@link ByteBuffer}.
*
* @param aBuffer
* The byte buffer to write to. If the buffer is too small, it is
* automatically extended. May not be null.
* @return {@link ESuccess}
* @throws BufferOverflowException
* If the ByteBuffer is too small
*/
@Nonnull
default ESuccess write (@Nonnull final ByteBuffer aBuffer)
{
return getWriter ().write (getObjectToWrite (), aBuffer);
}
/**
* Write the passed object to an {@link IWritableResource}.
*
* @param aResource
* The result resource to be written to. May not be null.
* @return {@link ESuccess}
*/
@Nonnull
default ESuccess write (@Nonnull final IWritableResource aResource)
{
return getWriter ().write (getObjectToWrite (), aResource);
}
/**
* Convert the passed object to XML.
*
* @param aMarshallerFunc
* The marshalling function. May not be null.
* @return {@link ESuccess}
*/
@Nonnull
default ESuccess write (@Nonnull final IJAXBMarshaller aMarshallerFunc)
{
return getWriter ().write (getObjectToWrite (), aMarshallerFunc);
}
/**
* Convert the passed object to XML. This method is potentially dangerous,
* when using StreamResult because it may create invalid XML. Only when using
* the {@link SafeXMLStreamWriter} it is ensured that only valid XML is
* created!
*
* @param aResult
* The result object holder. May not be null. Usually
* SAXResult, DOMResult and StreamResult are supported.
* @return {@link ESuccess}
*/
@Nonnull
default ESuccess write (@Nonnull final Result aResult)
{
return getWriter ().write (getObjectToWrite (), aResult);
}
/**
* Convert the passed object to XML.
*
* @param aHandler
* XML will be sent to this handler as SAX2 events. May not be
* null.
* @return {@link ESuccess}
*/
@Nonnull
default ESuccess write (@Nonnull final org.xml.sax.ContentHandler aHandler)
{
return getWriter ().write (getObjectToWrite (), aHandler);
}
/**
* Convert the passed object to XML.
*
* @param aWriter
* XML will be sent to this writer. May not be null.
* @return {@link ESuccess}
*/
@Nonnull
default ESuccess write (@Nonnull @WillClose final javax.xml.stream.XMLStreamWriter aWriter)
{
return getWriter ().write (getObjectToWrite (), aWriter);
}
/**
* Convert the passed object to a new DOM document (write).
*
* @return null if converting the document failed.
*/
@Nullable
default Document getAsDocument ()
{
return getWriter ().getAsDocument (getObjectToWrite ());
}
/**
* Convert the passed object to a new micro document (write).
*
* @return null if converting the document failed.
*/
@Nullable
default IMicroDocument getAsMicroDocument ()
{
return getWriter ().getAsMicroDocument (getObjectToWrite ());
}
/**
* Convert the passed object to a new micro document and return only the root
* element (write).
*
* @return null if converting the document failed.
*/
@Nullable
default IMicroElement getAsMicroElement ()
{
return getWriter ().getAsMicroElement (getObjectToWrite ());
}
/**
* Utility method to directly convert the passed domain object to an XML
* string (write).
*
* @return null if the passed domain object could not be
* converted because of validation errors.
*/
@Nullable
default String getAsString ()
{
return getWriter ().getAsString (getObjectToWrite ());
}
/**
* Write the passed object to a {@link ByteBuffer} and return it (write).
*
* @return null if the passed domain object could not be
* converted because of validation errors.
*/
@Nullable
default ByteBuffer getAsByteBuffer ()
{
return getWriter ().getAsByteBuffer (getObjectToWrite ());
}
/**
* Write the passed object to a byte array and return the created byte array
* (write).
*
* @return null if the passed domain object could not be
* converted because of validation errors.
*/
@Nullable
default byte [] getAsBytes ()
{
return getWriter ().getAsBytes (getObjectToWrite ());
}
/**
* Write the passed object to a byte array and return the input stream on that
* array.
*
* @return null if the passed domain object could not be
* converted because of validation errors.
*/
@Nullable
default NonBlockingByteArrayInputStream getAsInputStream ()
{
return getWriter ().getAsInputStream (getObjectToWrite ());
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy