com.helger.json.valueserializer.JsonValueSerializerEscaped Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ph-json Show documentation

JSON reader and writer libary

The newest version!

/*
 * Copyright (C) 2014-2024 Philip Helger (www.helger.com)
 * philip[at]helger[dot]com
 *
 * 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.helger.json.valueserializer;

import java.io.IOException;
import java.io.Writer;

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

import com.helger.commons.string.ToStringGenerator;
import com.helger.json.convert.JsonEscapeHelper;

/**
 * A special {@link IJsonValueSerializer} that writes an escaped string.
 *
 * @author Philip Helger
 */
public final class JsonValueSerializerEscaped implements IJsonValueSerializer
{
  private static final JsonValueSerializerEscaped INSTANCE = new JsonValueSerializerEscaped ();

  private JsonValueSerializerEscaped ()
  {}

  @Nonnull
  public static JsonValueSerializerEscaped getInstance ()
  {
    return INSTANCE;
  }

  public static void appendEscapedJsonString (@Nonnull final String sValue, @Nonnull @WillNotClose final Writer aWriter) throws IOException
  {
    aWriter.write ('"');
    JsonEscapeHelper.jsonEscapeToWriter (sValue, aWriter);
    aWriter.write ('"');
  }

  public void appendAsJsonString (@Nullable final Object aValue, @Nonnull @WillNotClose final Writer aWriter) throws IOException
  {
    appendEscapedJsonString (String.valueOf (aValue), aWriter);
  }

  @Override
  public String toString ()
  {
    return new ToStringGenerator (this).getToString ();
  }
}