io.github.mmm.marshall.AbstractMarshallingObject Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mmm-marshall Show documentation

API for marshalling and unmarshalling data.

The newest version!

/* Copyright (c) The m-m-m Team, Licensed under the Apache License, Version 2.0
 * http://www.apache.org/licenses/LICENSE-2.0 */
package io.github.mmm.marshall;

import io.github.mmm.marshall.id.StructuredIdMappingObject;

/**
 * Abstract base implementation of {@link MarshallingObject} for objects
 */
public abstract class AbstractMarshallingObject implements MarshallingObject, StructuredIdMappingObject {

  @Override
  public void write(StructuredWriter writer) {

    writer.writeStartObject(this);
    writeProperties(writer);
    writer.writeEnd();
  }

  /**
   * Writes all properties of this {@link MarshallingObject}.
   *
   * @param writer the {@link StructuredWriter} to write to.
   */
  protected abstract void writeProperties(StructuredWriter writer);

  @Override
  public MarshallingObject read(StructuredReader reader) {

    reader.require(StructuredState.START_OBJECT, true);
    while (!reader.readEnd()) {
      String name = reader.readName();
      readProperty(reader, name);
    }
    return this;
  }

  /**
   * Reads the property with the given {@code name} and applies it to this {@link MarshallingObject}.
   *
   * @param reader the {@link StructuredReader} to read from.
   * @param name the name of the property to read.
   */
  protected abstract void readProperty(StructuredReader reader, String name);

}