com.budjb.httprequests.converter.bundled.ByteArrayEntityWriter Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2016-2018 the original author or authors.
 *
 * 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.budjb.httprequests.converter.bundled;

import com.budjb.httprequests.converter.EntityWriter;

import java.io.ByteArrayInputStream;
import java.io.InputStream;

public class ByteArrayEntityWriter implements EntityWriter {
    /**
     * Returns a Content-Type of the converted object that will be set in the HTTP request.
     * 
     * If no Content-Type is known, null is returned.
     *
     * @return Content-Type of the converted object, or null if unknown.
     */
    @Override
    public String getContentType() {
        return "application/octet-stream";
    }

    /**
     * Determines whether the given class type is supported by the writer.
     *
     * @param type Type to convert.
     * @return Whether the type is supported.
     */
    @Override
    public boolean supports(Class type) {
        return type.isArray() && byte.class.isAssignableFrom(type.getComponentType());
    }

    /**
     * Convert the given entity.
     * 
     * If an error occurs, null may be returned so that another converter may attempt conversion.
     *
     * @param entity       Entity object to convert into a byte array.
     * @param characterSet The character set of the request.
     * @return An {@link InputStream} containing the converted entity.
     * @throws Exception when an unexpected error occurs.
     */
    @Override
    public InputStream write(Object entity, String characterSet) throws Exception {
        return new ByteArrayInputStream((byte[]) entity);
    }
}