InterfaceFieldAliasMapping.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you 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 org.apache.shindig.protocol.conversion.xstream;

/**
 * Maps of Interfaces to Aliases used by {@link org.apache.shindig.protocol.conversion.BeanXStreamConverter}
 */
public class InterfaceFieldAliasMapping {

  private String alias;
  private Class<?> type;
  private String fieldName;
  private String parent;

  /**
   * @param alias
   *          the name of the element to be used in the xml
   * @param type
   *          the type containing the field
   * @param fieldName
   *          the field name.
   */
  public InterfaceFieldAliasMapping(String alias, Class<?> type,
      String fieldName) {
    this.alias = alias;
    this.type = type;
    this.fieldName = fieldName;
  }

  /**
   * @param alias
   *          the name of the element to be used in the xml
   * @param type
   *          the type containing the field
   * @param fieldName
   *          the field name.
   * @param parent
   *          the parent element
   */
  public InterfaceFieldAliasMapping(String alias, Class<?> type,
      String fieldName, String parent) {
    this.alias = alias;
    this.type = type;
    this.fieldName = fieldName;
    this.parent = parent;
  }

  /**
   * @return
   */
  public Class<?> getType() {
    return type;
  }

  /**
   * @return
   */
  public String getAlias() {
    return alias;
  }

  /**
   * @return
   */
  public String getFieldName() {
    return fieldName;
  }

  /**
   * @return the parent
   */
  public String getParent() {
    return parent;
  }

  /**
   * {@inheritDoc}
   *
   * @see java.lang.Object#toString()
   */
  @Override
  public String toString() {
    if (parent == null) {
      return type + ".get" + fieldName + "() <-> <" + alias + '>';
    } else {
      return type + ".get" + fieldName + "() <-> <" + alias
          + "> inside parent <" + parent + '>';
    }
  }
}