br.com.uol.pagseguro.api.common.domain.converter.AbstractPhoneJsonConverter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of pagseguro-api Show documentation

A collection of domain classes to ease integrations with PagSeguro Api

The newest version!

/*
 * 2007-2016 [PagSeguro Internet Ltda.]
 *
 * NOTICE OF LICENSE
 *
 * 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.
 *
 * Copyright: 2007-2016 PagSeguro Internet Ltda.
 * Licence: http://www.apache.org/licenses/LICENSE-2.0
 */
package br.com.uol.pagseguro.api.common.domain.converter;

import br.com.uol.pagseguro.api.common.domain.Phone;
import br.com.uol.pagseguro.api.utils.AbstractJsonConverter;
import br.com.uol.pagseguro.api.utils.RequestJson;

/**
 * Abstract converter for phone.
 * Used to convert attributes of phone in request json.
 * This class must be implemented because the keys of the attributes of the request are dynamic.
 *
 * @author PagSeguro Internet Ltda.
 */
public abstract class AbstractPhoneJsonConverter extends AbstractJsonConverter {

  /**
   * Convert attributes of address in request json
   *
   * @param requestJson Request Json used to pass params to api
   * @param phone      The interface of phone
   * @see RequestJson
   * @see Phone
   * @see AbstractJsonConverter#convert(Object)
   */
  protected void convert(RequestJson requestJson, Phone phone) {
    requestJson.putString(getAreaCodeKey(), phone.getAreaCode());
    requestJson.putString(getPhoneNumberKey(), phone.getNumber());
  }

  /**
   * Get area code key
   *
   * @return The key to the area code is a key dynamic inserted in the implementation of this class.
   */
  protected abstract String getAreaCodeKey();

  /**
   * Get phone number key
   *
   * @return The key to the phone number is a key dynamic inserted in the implementation of this
   * class.
   */
  protected abstract String getPhoneNumberKey();

}