Coverage Report

Coverage Report - com.jcabi.w3c.ValidationResponse

Classes in this File

 /**
  * Copyright (c) 2011-2015, 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.w3c;
 
 import java.net.URI;
 import java.nio.charset.Charset;
 import java.util.Set;
 
 /**
  * Response of HTML or CSS validation.
  *
  * <p>See {@link ValidatorBuilder} for explanation of how to get an instance
  * of this interface.
  *
  * <p>Implementation must be immutable and thread-safe.
  *
  * @author Yegor Bugayenko (yegor@tpc2.com)
  * @version $Id$
  * @see ValidatorBuilder
  * @see Validator#validate(String)
  * @see <a href="http://validator.w3.org/docs/api.html">W3C API, HTML</a>
  * @see <a href="http://jigsaw.w3.org/css-validator/api.html">W3C API, CSS</a>
  */
 public interface ValidationResponse {
 
     /**
      * The document is valid and has no errors or warnings?
      * @return Is it valid?
      */
     boolean valid();
 
     /**
      * Who checked the document (normally contains a URL of W3C server).
      * @return URI of the server
      */
     URI checkedBy();
 
     /**
      * DOCTYPE of the document, if detected by the validator (may be empty
      * if {@code DOCTYPE} is not detected or if it's a CSS document).
      * @return Doctype or empty string
      */
     String doctype();
 
     /**
      * Charset of the document, if detected by the server (may be empty
      * if charset is not detected or it's a CSS document).
      * @return Charset of the document, e.g. {@code "UTF-8"}
      */
     Charset charset();
 
     /**
      * Returns list of errors found during validation.
      * @return List of errors or an empty list if no errors found
      */
     Set<Defect> errors();
 
     /**
      * Returns lsit of warnings found during validation.
      * @return List of warnings
      */
     Set<Defect> warnings();
 
 }

1		/**
2		* Copyright (c) 2011-2015, 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.w3c;
31
32		import java.net.URI;
33		import java.nio.charset.Charset;
34		import java.util.Set;
35
36		/**
37		* Response of HTML or CSS validation.
38		*
39		* <p>See {@link ValidatorBuilder} for explanation of how to get an instance
40		* of this interface.
41		*
42		* <p>Implementation must be immutable and thread-safe.
43		*
44		* @author Yegor Bugayenko (yegor@tpc2.com)
45		* @version $Id$
46		* @see ValidatorBuilder
47		* @see Validator#validate(String)
48		* @see <a href="http://validator.w3.org/docs/api.html">W3C API, HTML</a>
49		* @see <a href="http://jigsaw.w3.org/css-validator/api.html">W3C API, CSS</a>
50		*/
51		public interface ValidationResponse {
52
53		/**
54		* The document is valid and has no errors or warnings?
55		* @return Is it valid?
56		*/
57		boolean valid();
58
59		/**
60		* Who checked the document (normally contains a URL of W3C server).
61		* @return URI of the server
62		*/
63		URI checkedBy();
64
65		/**
66		* DOCTYPE of the document, if detected by the validator (may be empty
67		* if {@code DOCTYPE} is not detected or if it's a CSS document).
68		* @return Doctype or empty string
69		*/
70		String doctype();
71
72		/**
73		* Charset of the document, if detected by the server (may be empty
74		* if charset is not detected or it's a CSS document).
75		* @return Charset of the document, e.g. {@code "UTF-8"}
76		*/
77		Charset charset();
78
79		/**
80		* Returns list of errors found during validation.
81		* @return List of errors or an empty list if no errors found
82		*/
83		Set<Defect> errors();
84
85		/**
86		* Returns lsit of warnings found during validation.
87		* @return List of warnings
88		*/
89		Set<Defect> warnings();
90
91		}