All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.apache.juneau.rest.helper.StreamResourceBuilder Maven / Gradle / Ivy

Go to download

Apache Juneau UberJar

There is a newer version: 9.0.1
Show newest version
// ***************************************************************************************************************************
// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  See the NOTICE file *
// * distributed with this work for additional information regarding copyright ownership.  The ASF licenses this file        *
// * to you 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.apache.juneau.rest.helper;

import java.io.*;
import java.util.*;

import org.apache.juneau.http.*;

/**
 * Builder class for constructing {@link StreamResource} objects.
 *
 * 
See Also:

 * 
    
 * 	
  • {@doc juneau-rest-server.RestMethod.StreamResource}
 * 

 */
public final class StreamResourceBuilder {
	ArrayList contents = new ArrayList<>();
	MediaType mediaType;
	Map headers = new LinkedHashMap<>();

	/**
	 * Specifies the resource media type string.
	 *
	 * @param mediaType The resource media type string.
	 * @return This object (for method chaining).
	 */
	public StreamResourceBuilder mediaType(String mediaType) {
		this.mediaType = MediaType.forString(mediaType);
		return this;
	}

	/**
	 * Specifies the resource media type string.
	 *
	 * @param mediaType The resource media type string.
	 * @return This object (for method chaining).
	 */
	public StreamResourceBuilder mediaType(MediaType mediaType) {
		this.mediaType = mediaType;
		return this;
	}

	/**
	 * Specifies the contents for this resource.
	 *
	 * 

	 * This method can be called multiple times to add more content.
	 *
	 * @param contents
	 * 	The resource contents.
	 * 	
If multiple contents are specified, the results will be concatenated.
	 * 	
Contents can be any of the following:
	 * 	
    
	 * 		
  • byte[]
	 * 		
  • InputStream
	 * 		
  • Reader - Converted to UTF-8 bytes.
	 * 		
  • File
	 * 		
  • CharSequence - Converted to UTF-8 bytes.
	 * 	

	 * @return This object (for method chaining).
	 */
	public StreamResourceBuilder contents(Object...contents) {
		this.contents.addAll(Arrays.asList(contents));
		return this;
	}

	/**
	 * Specifies an HTTP response header value.
	 *
	 * @param name The HTTP header name.
	 * @param value
	 * 	The HTTP header value.
	 * 	
Will be converted to a String using {@link Object#toString()}.
	 * @return This object (for method chaining).
	 */
	public StreamResourceBuilder header(String name, Object value) {
		this.headers.put(name, value);
		return this;
	}

	/**
	 * Specifies HTTP response header values.
	 *
	 * @param headers
	 * 	The HTTP headers.
	 * 	
Values will be converted to Strings using {@link Object#toString()}.
	 * @return This object (for method chaining).
	 */
	public StreamResourceBuilder headers(Map headers) {
		this.headers.putAll(headers);
		return this;
	}

	/**
	 * Create a new {@link StreamResource} using values in this builder.
	 *
	 * @return A new immutable {@link StreamResource} object.
	 * @throws IOException
	 */
	public StreamResource build() throws IOException {
		return new StreamResource(mediaType, headers, contents.toArray());
	}
}    

    

    

            

    

            



    
    






    
© 2015 - 2024 Weber Informatics LLC | Privacy Policy