org.opentcs.util.persistence.ProbePlantModelTO Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of opentcs-common Show documentation

openTCS-Common

The newest version!

// SPDX-FileCopyrightText: The openTCS Authors
// SPDX-License-Identifier: MIT
package org.opentcs.util.persistence;

import static java.util.Objects.requireNonNull;

import jakarta.annotation.Nonnull;
import java.io.IOException;
import java.io.Reader;
import javax.xml.bind.JAXBContext;
import javax.xml.bind.JAXBException;
import javax.xml.bind.Unmarshaller;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlRootElement;
import org.xml.sax.SAXException;

/**
 * Allows reading a model file to access basic information (such as the model version) for
 * validation purposes.
 */
@XmlRootElement(name = "model")
@XmlAccessorType(XmlAccessType.PROPERTY)
public class ProbePlantModelTO
    extends
      BasePlantModelTO {

  /**
   * Creates a new instance.
   */
  public ProbePlantModelTO() {
  }

  /**
   * Unmarshals an instance of this class from the given XML representation.
   *
   * @param reader Provides the XML representation to parse to an instance.
   * @return The instance unmarshalled from the given reader.
   * @throws IOException If there was a problem unmarshalling the given string.
   */
  public static ProbePlantModelTO fromXml(
      @Nonnull
      Reader reader
  )
      throws IOException {
    requireNonNull(reader, "reader");

    try {
      return (ProbePlantModelTO) createUnmarshaller().unmarshal(reader);
    }
    catch (JAXBException | SAXException exc) {
      throw new IOException("Exception unmarshalling data", exc);
    }
  }

  private static Unmarshaller createUnmarshaller()
      throws JAXBException,
        SAXException {
    return createContext().createUnmarshaller();
  }

  private static JAXBContext createContext()
      throws JAXBException {
    return JAXBContext.newInstance(ProbePlantModelTO.class);
  }
}