com.rest4j.ObjectFactoryChain Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rest4j-core Show documentation

Framework for building RESTful services in Java

The newest version!

/*
 * 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 com.rest4j;

import com.rest4j.json.JSONException;
import com.rest4j.json.JSONObject;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

/**
 * This object is passed to the {@link ObjectFactory#createInstance(String, Class, com.rest4j.json.JSONObject, ObjectFactoryChain)}
 * as the reference to the next in the chain-of-responsibility.
 *
 * @author Joseph Kapizza 
 */
public interface ObjectFactoryChain {
	/**
	 * Creates the java instance from JSON object during unmarshalling. This is a pre-unmarshal operation: implementor
	 * might not fill the created object with any data, but may choose an appropriate class to instantiate depending on
	 * input data.
	 *
	 * @param modelName The 'name' attribute of the <model>.
	 * @param clz The 'class' attribute of the <model>.
	 * @param object The object being unmarshalled, not null.
	 * @return The java object instance that will be returned. Can return null, in which case the unmarshalled object
	 *         becomes null.
	 */
	@Nullable Object createInstance(
			@Nonnull String modelName,
			@Nonnull Class clz,
			@Nonnull JSONObject object) throws JSONException, ApiException;

}