com.helger.jaxb.IJAXBMarshaller Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ph-jaxb Show documentation

Special Java 1.8+ Library with extended JAXB support

The newest version!

/*
 * Copyright (C) 2014-2024 Philip Helger (www.helger.com)
 * philip[at]helger[dot]com
 *
 * 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.
 */
package com.helger.jaxb;

import javax.annotation.Nonnull;

import jakarta.xml.bind.JAXBElement;
import jakarta.xml.bind.JAXBException;
import jakarta.xml.bind.Marshaller;

/**
 * A special bi-consumer that additionally can throw a {@link JAXBException}
 *
 * @author Philip Helger
 * @param 
 *        The JAXB type to be written
 */
@FunctionalInterface
public interface IJAXBMarshaller 
{
  /**
   * @param aMarshaller
   *        The {@link Marshaller} to use. May not be null.
   * @param aJAXBElement
   *        The JAXB-Element to write. May not be null.
   * @throws JAXBException
   *         In case writing to XML fails.
   */
  void doMarshal (@Nonnull Marshaller aMarshaller, @Nonnull JAXBElement  aJAXBElement) throws JAXBException;
}