Coverage Report

Coverage Report - com.jcabi.xml.TextResource

Classes in this File

Line Coverage

Branch Coverage

Complexity

TextResource

80%

17/21

1/14

1.125

 /**
  * Copyright (c) 2012-2017, jcabi.com
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met: 1) Redistributions of source code must retain the above
  * copyright notice, this list of conditions and the following
  * disclaimer. 2) Redistributions in binary form must reproduce the above
  * copyright notice, this list of conditions and the following
  * disclaimer in the documentation and/or other materials provided
  * with the distribution. 3) Neither the name of the jcabi.com nor
  * the names of its contributors may be used to endorse or promote
  * products derived from this software without specific prior written
  * permission.
  *
  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
  * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
  * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
  * THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  * OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 package com.jcabi.xml;
 
 import java.io.BufferedInputStream;
 import java.io.File;
 import java.io.FileInputStream;
 import java.io.FileNotFoundException;
 import java.io.IOException;
 import java.io.InputStream;
 import java.net.URI;
 import java.net.URL;
 import java.util.Scanner;
 import lombok.EqualsAndHashCode;
 
 /**
  * Represent a given resource (InputStream, URL/URI location content, File)
  * as a string. UTF-8 encoding is used.
  *
  * <p>Objects of this class are immutable and thread-safe.
  *
  * @author Carlos Miranda (miranda.cma@gmail.com)
  * @version $Id: 3b97d0d16902fa49869b4b7f8089c61c821e0153 $
  */
 @EqualsAndHashCode(of = "content")
 final class TextResource {
 
     /**
      * The text representation.
      */
     private final transient String content;
 
     /**
      * Private constructor, used for initializing the field text content.
      * @param text The text content
      */
     private TextResource(final String text) {
         this.content = text;
     }
 
     /**
      * Public constructor, represent an InputStream as a text resource.
      *
      * <p>The provided input stream will be closed automatically after
      * getting data from it.
      * @param stream Stream to represent as text.
      */
     TextResource(final InputStream stream) {
         this(TextResource.readAsString(stream));
     }
 
     /**
      * Public constructor, represent a File as a text resource.
      * @param file File to represent as text.
      * @throws FileNotFoundException If file not found
      */
     TextResource(final File file) throws FileNotFoundException {
         this(
             TextResource.readAsString(
                 new BufferedInputStream(new FileInputStream(file))
             )
         );
     }
 
     /**
      * Public constructor, represent a URL location as a text resource.
      * @param url URL to represent as text.
      * @throws IOException If an IO problem occurs.
      */
     TextResource(final URL url) throws IOException {
         this(TextResource.readAsString(url));
     }
 
     /**
      * Public constructor, represent a URI location as a text resource.
      * @param uri URI to represent as text.
      * @throws IOException If an IO problem occurs.
      */
     TextResource(final URI uri) throws IOException {
         this(TextResource.readAsString(uri.toURL()));
     }
 
     @Override
     public String toString() {
         return this.content;
     }
 
     /**
      * Reads an entire stream's contents into a string.
      * @param stream The stream to read
      * @return The stream content, in String form
      */
     private static String readAsString(final InputStream stream) {
         final Scanner scanner =
             new Scanner(stream, "UTF-8").useDelimiter("\\A");
         final String result;
         try {
             if (scanner.hasNext()) {
                 result = scanner.next();
             } else {
                 result = "";
             }
         } finally {
             scanner.close();
         }
         return result;
     }
 
     /**
      * Reads URI contents into a string.
      * @param url The URL to read
      * @return The stream content, in String form
      * @throws IOException if an IO exception occurs
      */
     private static String readAsString(final URL url) throws IOException {
         return TextResource.readAsString(
             new BufferedInputStream(url.openStream())
         );
     }
 }

1		/**
2		* Copyright (c) 2012-2017, jcabi.com
3		* All rights reserved.
4		*
5		* Redistribution and use in source and binary forms, with or without
6		* modification, are permitted provided that the following conditions
7		* are met: 1) Redistributions of source code must retain the above
8		* copyright notice, this list of conditions and the following
9		* disclaimer. 2) Redistributions in binary form must reproduce the above
10		* copyright notice, this list of conditions and the following
11		* disclaimer in the documentation and/or other materials provided
12		* with the distribution. 3) Neither the name of the jcabi.com nor
13		* the names of its contributors may be used to endorse or promote
14		* products derived from this software without specific prior written
15		* permission.
16		*
17		* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18		* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
19		* NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
20		* FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
21		* THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
22		* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23		* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
24		* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25		* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
26		* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27		* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
28		* OF THE POSSIBILITY OF SUCH DAMAGE.
29		*/
30		package com.jcabi.xml;
31
32		import java.io.BufferedInputStream;
33		import java.io.File;
34		import java.io.FileInputStream;
35		import java.io.FileNotFoundException;
36		import java.io.IOException;
37		import java.io.InputStream;
38		import java.net.URI;
39		import java.net.URL;
40		import java.util.Scanner;
41		import lombok.EqualsAndHashCode;
42
43		/**
44		* Represent a given resource (InputStream, URL/URI location content, File)
45		* as a string. UTF-8 encoding is used.
46		*
47		* <p>Objects of this class are immutable and thread-safe.
48		*
49		* @author Carlos Miranda (miranda.cma@gmail.com)
50		* @version $Id: 3b97d0d16902fa49869b4b7f8089c61c821e0153 $
51		*/
52	0	@EqualsAndHashCode(of = "content")
53		final class TextResource {
54
55		/**
56		* The text representation.
57		*/
58		private final transient String content;
59
60		/**
61		* Private constructor, used for initializing the field text content.
62		* @param text The text content
63		*/
64	11	private TextResource(final String text) {
65	11	this.content = text;
66	11	}
67
68		/**
69		* Public constructor, represent an InputStream as a text resource.
70		*
71		* <p>The provided input stream will be closed automatically after
72		* getting data from it.
73		* @param stream Stream to represent as text.
74		*/
75		TextResource(final InputStream stream) {
76	5	this(TextResource.readAsString(stream));
77	5	}
78
79		/**
80		* Public constructor, represent a File as a text resource.
81		* @param file File to represent as text.
82		* @throws FileNotFoundException If file not found
83		*/
84		TextResource(final File file) throws FileNotFoundException {
85	2	this(
86		TextResource.readAsString(
87		new BufferedInputStream(new FileInputStream(file))
88		)
89		);
90	2	}
91
92		/**
93		* Public constructor, represent a URL location as a text resource.
94		* @param url URL to represent as text.
95		* @throws IOException If an IO problem occurs.
96		*/
97		TextResource(final URL url) throws IOException {
98	4	this(TextResource.readAsString(url));
99	4	}
100
101		/**
102		* Public constructor, represent a URI location as a text resource.
103		* @param uri URI to represent as text.
104		* @throws IOException If an IO problem occurs.
105		*/
106		TextResource(final URI uri) throws IOException {
107	0	this(TextResource.readAsString(uri.toURL()));
108	0	}
109
110		@Override
111		public String toString() {
112	11	return this.content;
113		}
114
115		/**
116		* Reads an entire stream's contents into a string.
117		* @param stream The stream to read
118		* @return The stream content, in String form
119		*/
120		private static String readAsString(final InputStream stream) {
121	11	final Scanner scanner =
122		new Scanner(stream, "UTF-8").useDelimiter("\\A");
123		final String result;
124		try {
125	11	if (scanner.hasNext()) {
126	11	result = scanner.next();
127		} else {
128	0	result = "";
129		}
130		} finally {
131	11	scanner.close();
132	11	}
133	11	return result;
134		}
135
136		/**
137		* Reads URI contents into a string.
138		* @param url The URL to read
139		* @return The stream content, in String form
140		* @throws IOException if an IO exception occurs
141		*/
142		private static String readAsString(final URL url) throws IOException {
143	4	return TextResource.readAsString(
144		new BufferedInputStream(url.openStream())
145		);
146		}
147		}