org.springframework.social.facebook.api.FacebookObject Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of spring-social-facebook Show documentation

The newest version!

/*
 * Copyright 2015 the original author or authors.
 *
 * 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 org.springframework.social.facebook.api;

import java.util.HashMap;
import java.util.Map;

import com.fasterxml.jackson.annotation.JsonAnySetter;

/**
 * Base class for all Facebook types.
 * Offers an extraData property for carrying any data in response from Facebook that won't be otherwise mapped to any properties of the subclass.
 * @author Craig Walls
 */
public abstract class FacebookObject {

	private Map extraData;

	public FacebookObject() {
		this.extraData = new HashMap();
	}
	
	/**
	 * @return Any fields in response from Facebook that are otherwise not mapped to any properties.
	 */
	public Map getExtraData() {
		return extraData;
	}
	
	/**
	 * {@link JsonAnySetter} hook. Called when an otherwise unmapped property is being processed during JSON deserialization.
	 * @param key The property's key.
	 * @param value The property's value.
	 */
	protected void add(String key, Object value) {
		extraData.put(key, value);
	}

}