com.landawn.abacus.parser.JSONSerializationConfig Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of abacus-common Show documentation
Show all versions of abacus-common Show documentation
A general programming library in Java/Android. It's easy to learn and simple to use with concise and powerful APIs.
/*
* Copyright (C) 2015 HaiYang Li
*
* 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 com.landawn.abacus.parser;
import java.util.Map;
import java.util.Set;
import com.landawn.abacus.annotation.SuppressFBWarnings;
import com.landawn.abacus.util.DateTimeFormat;
import com.landawn.abacus.util.N;
/**
*
* @author Haiyang Li
* @since 0.8
*/
public class JSONSerializationConfig extends SerializationConfig {
protected static final boolean defaultQuotePropName = true;
protected static final boolean defaultQuoteMapKey = true;
protected static final boolean defaultWrapRootValue = false;
protected static final boolean defaultBracketRootValue = true;
boolean writeNullToEmpty = false;
boolean quotePropName = defaultQuotePropName;
boolean quoteMapKey = defaultQuoteMapKey;
boolean wrapRootValue = defaultWrapRootValue;
boolean bracketRootValue = defaultBracketRootValue;
/**
*
*/
public JSONSerializationConfig() { //NOSONAR
}
/**
*
* @return
*/
public boolean writeNullToEmpty() {
return writeNullToEmpty;
}
/**
*
* @param writeNullToEmpty
* @return
*/
public JSONSerializationConfig writeNullToEmpty(boolean writeNullToEmpty) {
this.writeNullToEmpty = writeNullToEmpty;
return this;
}
/**
* Sets the char quotation.
*
* @param charQuotation
* @return
* @deprecated this method should not be called
*/
@Deprecated
@Override
public JSONSerializationConfig setCharQuotation(char charQuotation) {
super.setCharQuotation(charQuotation);
return this;
}
/**
* Sets the string quotation.
*
* @param stringQuotation
* @return
* @deprecated this method should not be called
*/
@Deprecated
@Override
public JSONSerializationConfig setStringQuotation(char stringQuotation) {
super.setStringQuotation(stringQuotation);
return this;
}
/**
* Sets the string quotation.
*
* @return
* @deprecated this method should not be called
*/
@Deprecated
@Override
public JSONSerializationConfig noCharQuotation() {
super.noCharQuotation();
return this;
}
/**
* Sets the string quotation.
*
* @return
* @deprecated this method should not be called
*/
@Deprecated
@Override
public JSONSerializationConfig noStringQuotation() {
super.noStringQuotation();
return this;
}
/**
* Sets the string quotation.
*
* @return
* @deprecated this method should not be called
*/
@Deprecated
@Override
public JSONSerializationConfig noQuotation() {
super.noQuotation();
return this;
}
/**
* The default value is false if it's not set.
*
* @return true, if is quote prop name
*/
public boolean quotePropName() {
return quotePropName;
}
/**
* Sets the quote prop name.
*
* @param quotePropName
* @return
*/
public JSONSerializationConfig quotePropName(boolean quotePropName) {
this.quotePropName = quotePropName;
return this;
}
/**
* The default value is false if it's not set.
*
* @return true, if is quote map key
*/
public boolean quoteMapKey() {
return quoteMapKey;
}
/**
* Sets the quote map key.
*
* @param quoteMapKey
* @return
*/
public JSONSerializationConfig quoteMapKey(boolean quoteMapKey) {
this.quoteMapKey = quoteMapKey;
return this;
}
/**
* Checks if is wrap root value.
*
* @return true, if is wrap root value
*/
public boolean wrapRootValue() {
return wrapRootValue;
}
/**
* Sets the wrap root value.
*
* @param wrapRootValue
* @return
*/
public JSONSerializationConfig wrapRootValue(boolean wrapRootValue) {
this.wrapRootValue = wrapRootValue;
return this;
}
/**
* The default value is true if it's not set.
*
* @return true, if is bracket root value
*/
public boolean bracketRootValue() {
return bracketRootValue;
}
/**
* It's set to if enclose the JSON string/text with '{' and '}' or '[' and
* ']'.
*
* @param bracketRootValue
* @return
*/
public JSONSerializationConfig bracketRootValue(boolean bracketRootValue) {
this.bracketRootValue = bracketRootValue;
return this;
}
// /**
// *
// * @return
// */
// @Override
// public JSONSerializationConfig copy() {
// final JSONSerializationConfig copy = new JSONSerializationConfig();
//
// copy.setIgnoredPropNames(this.getIgnoredPropNames());
// copy.setCharQuotation(this.getCharQuotation());
// copy.setStringQuotation(this.getStringQuotation());
// copy.setDateTimeFormat(this.getDateTimeFormat());
// copy.setExclusion(this.getExclusion());
// copy.setSkipTransientField(this.isSkipTransientField());
// copy.setPrettyFormat(this.isPrettyFormat());
// copy.supportCircularReference(this.supportCircularReference());
// copy.writeBigDecimalAsPlain(this.writeBigDecimalAsPlain());
// copy.setIndentation(this.getIndentation());
// copy.setPropNamingPolicy(this.getPropNamingPolicy());
// copy.setIgnoredPropNames(this.getIgnoredPropNames());
// copy.quotePropName = this.quotePropName;
// copy.quoteMapKey = this.quoteMapKey;
// copy.wrapRootValue = this.wrapRootValue;
// copy.bracketRootValue = this.bracketRootValue;
//
// return copy;
// }
/**
*
*
* @return
*/
@Override
public int hashCode() {
int h = 17;
h = 31 * h + N.hashCode(getIgnoredPropNames());
h = 31 * h + N.hashCode(getCharQuotation());
h = 31 * h + N.hashCode(getStringQuotation());
h = 31 * h + N.hashCode(getDateTimeFormat());
h = 31 * h + N.hashCode(getExclusion());
h = 31 * h + N.hashCode(skipTransientField());
h = 31 * h + N.hashCode(prettyFormat());
h = 31 * h + N.hashCode(supportCircularReference());
h = 31 * h + N.hashCode(writeLongAsString());
h = 31 * h + N.hashCode(writeNullStringAsEmpty);
h = 31 * h + N.hashCode(writeNullNumberAsZero);
h = 31 * h + N.hashCode(writeNullBooleanAsFalse);
h = 31 * h + N.hashCode(writeNullToEmpty);
h = 31 * h + N.hashCode(writeBigDecimalAsPlain());
h = 31 * h + N.hashCode(getIndentation());
h = 31 * h + N.hashCode(getPropNamingPolicy());
h = 31 * h + N.hashCode(getIgnoredPropNames());
h = 31 * h + N.hashCode(quotePropName);
h = 31 * h + N.hashCode(quoteMapKey);
h = 31 * h + N.hashCode(wrapRootValue);
return 31 * h + N.hashCode(bracketRootValue);
}
/**
*
* @param obj
* @return true, if successful
*/
@SuppressFBWarnings
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj instanceof JSONSerializationConfig other) {
if (N.equals(getIgnoredPropNames(), other.getIgnoredPropNames()) && N.equals(getCharQuotation(), other.getCharQuotation()) //NOSONAR
&& N.equals(getStringQuotation(), other.getStringQuotation()) && N.equals(getDateTimeFormat(), other.getDateTimeFormat())
&& N.equals(getExclusion(), other.getExclusion()) && N.equals(skipTransientField(), other.skipTransientField())
&& N.equals(prettyFormat(), other.prettyFormat()) && N.equals(supportCircularReference(), other.supportCircularReference())
&& N.equals(writeLongAsString(), other.writeLongAsString()) && N.equals(writeNullStringAsEmpty, other.writeNullStringAsEmpty)
&& N.equals(writeNullNumberAsZero, other.writeNullNumberAsZero) && N.equals(writeNullBooleanAsFalse, other.writeNullBooleanAsFalse)
&& N.equals(writeBigDecimalAsPlain(), other.writeBigDecimalAsPlain()) && N.equals(getIndentation(), other.getIndentation())
&& N.equals(getPropNamingPolicy(), other.getPropNamingPolicy()) && N.equals(quotePropName, other.quotePropName)
&& N.equals(quoteMapKey, other.quoteMapKey) && N.equals(wrapRootValue, other.wrapRootValue)
&& N.equals(bracketRootValue, other.bracketRootValue)) {
return true;
}
}
return false;
}
/**
*
*
* @return
*/
@Override
public String toString() {
return "{ignoredPropNames=" + N.toString(getIgnoredPropNames()) + ", charQuotation=" + N.toString(getCharQuotation()) + ", stringQuotation="
+ N.toString(getStringQuotation()) + ", dateTimeFormat=" + N.toString(getDateTimeFormat()) + ", exclusion=" + N.toString(getExclusion())
+ ", skipTransientField=" + N.toString(skipTransientField()) + ", prettyFormat=" + N.toString(prettyFormat()) + ", supportCircularReference="
+ N.toString(supportCircularReference()) + ", writeLongAsString=" + N.toString(writeLongAsString()) + ", writeNullStringAsEmpty="
+ N.toString(writeNullStringAsEmpty) + ", writeNullNumberAsZero=" + N.toString(writeNullNumberAsZero) + ", writeNullBooleanAsFalse="
+ N.toString(writeNullBooleanAsFalse) + ", writeNullToEmpty=" + N.toString(writeNullToEmpty) + ", writeBigDecimalAsPlain="
+ N.toString(writeBigDecimalAsPlain()) + ", indentation=" + N.toString(getIndentation()) + ", propNamingPolicy="
+ N.toString(getPropNamingPolicy()) + ", ignoredPropNames=" + N.toString(getIgnoredPropNames()) + ", quotePropName=" + N.toString(quotePropName)
+ ", quoteMapKey=" + N.toString(quoteMapKey) + ", wrapRootValue=" + N.toString(wrapRootValue) + ", bracketRootValue="
+ N.toString(bracketRootValue) + "}";
}
/**
* The Class JSC.
*/
public static final class JSC extends JSONSerializationConfig {
/**
*
* @return
*/
public static JSONSerializationConfig create() {
return new JSONSerializationConfig();
}
/**
*
* @param quotePropName
* @param quoteMapKey
* @return
* @deprecated to be removed in future version.
*/
@Deprecated
public static JSONSerializationConfig of(boolean quotePropName, boolean quoteMapKey) {
return create().quotePropName(quotePropName).quoteMapKey(quoteMapKey);
}
/**
*
* @param dateTimeFormat
* @return
* @deprecated to be removed in future version.
*/
@Deprecated
public static JSONSerializationConfig of(DateTimeFormat dateTimeFormat) {
return create().setDateTimeFormat(dateTimeFormat);
}
/**
*
* @param exclusion
* @param ignoredPropNames
* @return
* @deprecated to be removed in future version.
*/
@Deprecated
public static JSONSerializationConfig of(Exclusion exclusion, Map, Set> ignoredPropNames) {
return create().setExclusion(exclusion).setIgnoredPropNames(ignoredPropNames);
}
/**
*
* @param quotePropName
* @param quoteMapKey
* @param dateTimeFormat
* @param exclusion
* @param ignoredPropNames
* @return
* @deprecated to be removed in future version.
*/
@Deprecated
public static JSONSerializationConfig of(boolean quotePropName, boolean quoteMapKey, DateTimeFormat dateTimeFormat, Exclusion exclusion,
Map, Set> ignoredPropNames) {
return create().quotePropName(quotePropName)
.quoteMapKey(quoteMapKey)
.setDateTimeFormat(dateTimeFormat)
.setExclusion(exclusion)
.setIgnoredPropNames(ignoredPropNames);
}
}
}