com.google.api.server.spi.config.Transformer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of endpoints-framework Show documentation

A framework for building RESTful web APIs.

The newest version!

/*
 * Copyright 2016 Google Inc. All Rights Reserved.
 *
 * 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.google.api.server.spi.config;

/**
 * An interface used to transform between a bean type and another type during JSON serialization.
 * 
 * A serializer is constructed using one of the following constructor signatures (sorted by
 * precedence):
 * 

 * A constructor taking in a single {@code java.lang.reflect.Type}. This is the type being
 * serialized.
 * A constructor taking in a single {@code java.lang.Class}. This is the class being serialized.
 * 
 * A no-arg constructor
 * 
 *
 * @param  The type being transformed
 * @param  The type being transformed to
 */
public interface Transformer {
  /**
   * Converts the source object into the destination type.
   */
  TTo transformTo(TFrom in);

  /**
   * Converts an object from the destination type into the source type.
   */
  TFrom transformFrom(TTo in);
}