/*
 *
 *  Copyright 2017-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
 *
 *         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 springfox.documentation.schema;

import static java.util.Optional.ofNullable;

import java.util.ArrayList;
import java.util.List;
import java.util.Objects;
import java.util.Optional;

import com.fasterxml.jackson.annotation.JsonInclude;

import springfox.documentation.service.VendorExtension;

@JsonInclude(JsonInclude.Include.NON_EMPTY)
public class Example {
	private final String id;
	private final String summary;
	private final String description;
	private final Object value;
	private final String externalValue;
	private final String mediaType;
	private final List<VendorExtension> extensions = new ArrayList<>();

	/**
	 * @deprecated @since 3.0.0 Use @see
	 *             {@link Example#Example(String, String, String, Object, String, String)}
	 * @param value - example literal
	 */
	@Deprecated
	public Example(Object value) {
		this.value = value;
		this.mediaType = null;
		externalValue = null;
		id = null;
		summary = null;
		description = null;
	}

	/**
	 * @deprecated @since 3.0.0 Use @see
	 *             {@link Example#Example(String, String, String, Object, String, String)}
	 * @param mediaType - media type of the example
	 * @param value     - example literal
	 */
	@Deprecated
	public Example(String mediaType, Object value) {
		this.mediaType = mediaType;
		this.value = value;
		externalValue = null;
		id = null;
		summary = null;
		description = null;
	}

	public Example(String id, String summary, String description, Object value, String externalValue,
			String mediaType) {
		this.id = id;
		this.summary = summary;
		this.description = description;
		this.value = value;
		this.externalValue = externalValue;
		this.mediaType = mediaType;
	}

	public String getId() {
		return id;
	}

	public String getSummary() {
		return summary;
	}

	public String getDescription() {
		return description;
	}

	public String getExternalValue() {
		return externalValue;
	}

	public List<VendorExtension> getExtensions() {
		return extensions;
	}

	public Object getValue() {
		return value;
	}

	public Optional<String> getMediaType() {
		return ofNullable(mediaType);
	}

	@Override
	public String toString() {
		return String.valueOf(value);
	}

	@Override
	public boolean equals(Object o) {
		if (this == o) {
			return true;
		}
		if (o == null || getClass() != o.getClass()) {
			return false;
		}
		Example example = (Example) o;
		return id != null && id.equals(example.id) && Objects.equals(summary,
				example.summary)
				&& Objects.equals(description, example.description) && value.equals(example.value)
				&& externalValue.equals(example.externalValue) && mediaType.equals(example.mediaType)
				&& extensions.equals(example.extensions);
	}

	@Override
	public int hashCode() {
		return Objects.hash(id, summary, description, value, externalValue, mediaType, extensions);
	}
}