org.snakeyaml.engine.v2.api.StreamDataWriter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of snakeyaml-engine Show documentation

Core YAML 1.2 parser and emitter for Java

The newest version!

/*
 * Copyright (c) 2018, SnakeYAML
 *
 * 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 org.snakeyaml.engine.v2.api;

/**
 * Writer with the same methods as in {@link java.io.Writer} but without throwing IOExceptions The
 * purpose of this class is to avoid checked exceptions in every method signature. Implementations
 * must define their own way to react on IOExceptions {@link YamlOutputStreamWriter}
 */
public interface StreamDataWriter {

  /**
   * Flushes this stream by writing any buffered output to the underlying stream.
   */
  default void flush() {}

  /**
   * write the whole data
   *
   * @param str - data to write
   */
  void write(String str);

  /**
   * Write part of the data
   *
   * @param str - the data to write (the source)
   * @param off - offset to start from
   * @param len - number of chars to write
   */
  void write(String str, int off, int len);
}