com.formkiq.client.model.DocumentFulltextResponse Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of client Show documentation
Show all versions of client Show documentation
The Official Client library for FormKiQ
The newest version!
/*
* FormKiQ HTTP API Formkiq API: Document Management Platform API using JWT Authentication
*
* The version of the OpenAPI document: 1.12.0 Contact: [email protected]
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech Do not edit the class manually.
*/
package com.formkiq.client.model;
import java.util.Objects;
import java.util.Arrays;
import com.formkiq.client.model.FulltextSearchItem;
import com.google.gson.TypeAdapter;
import com.google.gson.annotations.JsonAdapter;
import com.google.gson.annotations.SerializedName;
import com.google.gson.stream.JsonReader;
import com.google.gson.stream.JsonWriter;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.google.gson.JsonArray;
import com.google.gson.JsonDeserializationContext;
import com.google.gson.JsonDeserializer;
import com.google.gson.JsonElement;
import com.google.gson.JsonObject;
import com.google.gson.JsonParseException;
import com.google.gson.TypeAdapterFactory;
import com.google.gson.reflect.TypeToken;
import com.google.gson.TypeAdapter;
import com.google.gson.stream.JsonReader;
import com.google.gson.stream.JsonWriter;
import java.io.IOException;
import java.lang.reflect.Type;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
import com.formkiq.client.invoker.JSON;
/**
* DocumentFulltextResponse
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen",
date = "2023-08-13T13:53:13.529619-05:00[America/Winnipeg]")
public class DocumentFulltextResponse {
public static final String SERIALIZED_NAME_DOCUMENTS = "documents";
@SerializedName(SERIALIZED_NAME_DOCUMENTS)
private List documents;
public DocumentFulltextResponse() {}
public DocumentFulltextResponse documents(List documents) {
this.documents = documents;
return this;
}
public DocumentFulltextResponse addDocumentsItem(FulltextSearchItem documentsItem) {
if (this.documents == null) {
this.documents = new ArrayList<>();
}
this.documents.add(documentsItem);
return this;
}
/**
* List of search result documents
*
* @return documents
**/
@javax.annotation.Nullable
public List getDocuments() {
return documents;
}
public void setDocuments(List documents) {
this.documents = documents;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
DocumentFulltextResponse documentFulltextResponse = (DocumentFulltextResponse) o;
return Objects.equals(this.documents, documentFulltextResponse.documents);
}
@Override
public int hashCode() {
return Objects.hash(documents);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class DocumentFulltextResponse {\n");
sb.append(" documents: ").append(toIndentedString(documents)).append("\n");
sb.append("}");
return sb.toString();
}
/**
* Convert the given object to string with each line indented by 4 spaces (except the first line).
*/
private String toIndentedString(Object o) {
if (o == null) {
return "null";
}
return o.toString().replace("\n", "\n ");
}
public static HashSet openapiFields;
public static HashSet openapiRequiredFields;
static {
// a set of all properties/fields (JSON key names)
openapiFields = new HashSet();
openapiFields.add("documents");
// a set of required properties/fields (JSON key names)
openapiRequiredFields = new HashSet();
}
/**
* Validates the JSON Object and throws an exception if issues found
*
* @param jsonObj JSON Object
* @throws IOException if the JSON Object is invalid with respect to DocumentFulltextResponse
*/
public static void validateJsonObject(JsonObject jsonObj) throws IOException {
if (jsonObj == null) {
if (!DocumentFulltextResponse.openapiRequiredFields.isEmpty()) { // has required fields but
// JSON object is null
throw new IllegalArgumentException(String.format(
"The required field(s) %s in DocumentFulltextResponse is not found in the empty JSON string",
DocumentFulltextResponse.openapiRequiredFields.toString()));
}
}
Set> entries = jsonObj.entrySet();
// check to see if the JSON string contains additional fields
for (Entry entry : entries) {
if (!DocumentFulltextResponse.openapiFields.contains(entry.getKey())) {
throw new IllegalArgumentException(String.format(
"The field `%s` in the JSON string is not defined in the `DocumentFulltextResponse` properties. JSON: %s",
entry.getKey(), jsonObj.toString()));
}
}
if (jsonObj.get("documents") != null && !jsonObj.get("documents").isJsonNull()) {
JsonArray jsonArraydocuments = jsonObj.getAsJsonArray("documents");
if (jsonArraydocuments != null) {
// ensure the json data is an array
if (!jsonObj.get("documents").isJsonArray()) {
throw new IllegalArgumentException(String.format(
"Expected the field `documents` to be an array in the JSON string but got `%s`",
jsonObj.get("documents").toString()));
}
// validate the optional field `documents` (array)
for (int i = 0; i < jsonArraydocuments.size(); i++) {
FulltextSearchItem.validateJsonObject(jsonArraydocuments.get(i).getAsJsonObject());
} ;
}
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!DocumentFulltextResponse.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'DocumentFulltextResponse' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter =
gson.getDelegateAdapter(this, TypeToken.get(DocumentFulltextResponse.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, DocumentFulltextResponse value) throws IOException {
JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject();
elementAdapter.write(out, obj);
}
@Override
public DocumentFulltextResponse read(JsonReader in) throws IOException {
JsonObject jsonObj = elementAdapter.read(in).getAsJsonObject();
validateJsonObject(jsonObj);
return thisAdapter.fromJsonTree(jsonObj);
}
}.nullSafe();
}
}
/**
* Create an instance of DocumentFulltextResponse given an JSON string
*
* @param jsonString JSON string
* @return An instance of DocumentFulltextResponse
* @throws IOException if the JSON string is invalid with respect to DocumentFulltextResponse
*/
public static DocumentFulltextResponse fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, DocumentFulltextResponse.class);
}
/**
* Convert an instance of DocumentFulltextResponse to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}