/*
 * Copyright 2014-2019 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
 *
 *      https://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.restdocs.payload;

/**
 * A {@code FieldTypesDoNotMatchException} is thrown when the documented and actual types
 * of a field do not match.
 *
 * @author Andy Wilkinson
 */
class FieldTypesDoNotMatchException extends RuntimeException {

	/**
	 * Creates a new {@code FieldTypesDoNotMatchException} for the field described by the
	 * given {@code fieldDescriptor} that has the given {@code actualType}.
	 * @param fieldDescriptor the field
	 * @param actualType the actual type of the field
	 */
	FieldTypesDoNotMatchException(FieldDescriptor fieldDescriptor, Object actualType) {
		super("The documented type of the field '" + fieldDescriptor.getPath() + "' is " + fieldDescriptor.getType()
				+ " but the actual type is " + actualType);
	}

}
