com.marklogic.client.io.StringHandle Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2012-2016 MarkLogic Corporation
 *
 * 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.marklogic.client.io;

import java.io.IOException;
import java.io.OutputStream;
import java.io.UnsupportedEncodingException;
import java.nio.charset.Charset;

import com.marklogic.client.MarkLogicIOException;
import com.marklogic.client.io.marker.BufferableHandle;
import com.marklogic.client.io.marker.ContentHandle;
import com.marklogic.client.io.marker.ContentHandleFactory;
import com.marklogic.client.io.marker.JSONReadHandle;
import com.marklogic.client.io.marker.JSONWriteHandle;
import com.marklogic.client.io.marker.QuadsWriteHandle;
import com.marklogic.client.io.marker.SPARQLResultsReadHandle;
import com.marklogic.client.io.marker.StructureReadHandle;
import com.marklogic.client.io.marker.StructureWriteHandle;
import com.marklogic.client.io.marker.TextReadHandle;
import com.marklogic.client.io.marker.TextWriteHandle;
import com.marklogic.client.io.marker.TriplesReadHandle;
import com.marklogic.client.io.marker.TriplesWriteHandle;
import com.marklogic.client.io.marker.XMLReadHandle;
import com.marklogic.client.io.marker.XMLWriteHandle;

/**
 * A String Handle represents document content as a string for reading or writing.
 */
public class StringHandle
	extends BaseHandle
	implements OutputStreamSender, BufferableHandle, ContentHandle,
		JSONReadHandle, JSONWriteHandle, 
		TextReadHandle, TextWriteHandle,
		XMLReadHandle, XMLWriteHandle,
		StructureReadHandle, StructureWriteHandle,
		QuadsWriteHandle, 
		TriplesReadHandle, TriplesWriteHandle,
		SPARQLResultsReadHandle
{
	private String content;

	/**
	 * Creates a factory to create a StringHandle instance for a string.
	 * @return	the factory
	 */
	static public ContentHandleFactory newFactory() {
		return new ContentHandleFactory() {
			@Override
			public Class[] getHandledClasses() {
				return new Class[]{ String.class };
			}
			@Override
			public boolean isHandled(Class type) {
				return String.class.isAssignableFrom(type);
			}
			@Override
			public  ContentHandle newHandle(Class type) {
				@SuppressWarnings("unchecked")
				ContentHandle handle = isHandled(type) ?
						(ContentHandle) new StringHandle() : null;
				return handle;
			}
		};
	}

	/**
	 * Zero-argument constructor.
	 */
	public StringHandle() {
		super();
   		setResendable(true);
	}
	/**
	 * Initializes the handle with a string for the content.
	 * @param content	a content string
	 */
	public StringHandle(String content) {
		this();
		set(content);
	}

	/**
	 * Returns the string for the content.
	 * @return	the string
	 */
	@Override
	public String get() {
		return content;
	}
	/**
	 * Assigns an string as the content.
	 * @param content	a string
	 */
	@Override
	public void set(String content) {
		this.content = content;
	}
    /**
	 * Assigns a string as the content and returns the handle
	 * as a fluent convenience.
	 * @param content	a string
	 * @return	this handle
     */
	public StringHandle with(String content) {
		set(content);
		return this;
	}

	/**
	 * Specifies the format of the content and returns the handle
	 * as a fluent convenience.
	 * @param format	the format of the content
	 * @return	this handle
	 */
	public StringHandle withFormat(Format format) {
		setFormat(format);
		return this;
	}
	/**
	 * Specifies the mime type of the content and returns the handle
	 * as a fluent convenience.
	 * @param mimetype	the mime type of the content
	 * @return	this handle
	 */
	public StringHandle withMimetype(String mimetype) {
		setMimetype(mimetype);
		return this;
	}

	@Override
	public void fromBuffer(byte[] buffer) {
		if (buffer == null || buffer.length == 0)
			content = null;
		else
			content = new String(buffer, Charset.forName("UTF-8"));
	}
	@Override
	public byte[] toBuffer() {
		if (content == null)
			return null;

		return content.getBytes(Charset.forName("UTF-8"));
	}
	/**
	 * Returns the content.
	 */
	@Override
	public String toString() {
		return content;
	}

	@Override
	protected Class receiveAs() {
		return byte[].class;
	}
	@Override
	protected void receiveContent(byte[] content) {
		try {
			if (content == null) {
				this.content = null;
				return;
			}

			this.content = new String(content, "UTF-8");
		} catch (UnsupportedEncodingException e) {
			throw new MarkLogicIOException(e);
		}
	}
	@Override
	protected OutputStreamSender sendContent() {
		if (content == null) {
			throw new IllegalStateException("No string to write");
		}

		return this;
	}
	@Override
	public void write(OutputStream out) throws IOException {
		out.write(toBuffer());
	}
}