it.tidalwave.thesefoolishthings.examples.person.XStreamMarshallableSupport Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of it-tidalwave-thesefoolishthings-examples-dci-marshal-xstream Show documentation

An example of how XStream can be integrated by means of Roles.

There is a newer version: 5.0-ALPHA-3

Show newest version

/*
 * #%L
 * *********************************************************************************************************************
 * 
 * These Foolish Things - Miscellaneous utilities
 * http://thesefoolishthings.tidalwave.it - git clone [email protected]:tidalwave/thesefoolishthings-src.git
 * %%
 * Copyright (C) 2009 - 2016 Tidalwave s.a.s. (http://tidalwave.it)
 * %%
 * *********************************************************************************************************************
 * 
 * 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.
 * 
 * *********************************************************************************************************************
 * 
 * $Id$
 * 
 * *********************************************************************************************************************
 * #L%
 */
package it.tidalwave.thesefoolishthings.examples.person;

import javax.annotation.Nonnull;
import java.io.IOException;
import java.io.OutputStream;
import it.tidalwave.role.Marshallable;
import it.tidalwave.thesefoolishthings.examples.dci.marshal.xstream.XStreamContext;
import lombok.RequiredArgsConstructor;

/***********************************************************************************************************************
 *
 * A facility class for implementing a {@link Marshallable} using XStream. Subclass properly and eventually override
 * {@link #getMarshallingObject(java.lang.Object)} when only a part of the datum must be considered by XStream.
 * 
 * @author  Fabrizio Giudici
 * @version $Id$
 *
 **********************************************************************************************************************/
@RequiredArgsConstructor
public abstract class XStreamMarshallableSupport implements Marshallable
  {
    @Nonnull
    private final D datum;

    @Nonnull
    private final XStreamContext xStreamContext;

    @Override
    public final void marshal (final @Nonnull OutputStream os)
      throws IOException
      {
        xStreamContext.getXStream().toXML(getMarshallingObject(datum), os);
      }

    @Nonnull
    protected Object getMarshallingObject (final @Nonnull D datum)
      {
        return datum;
      }
  }