static/apidocs/org/apache/sis/storage/ProbeResult.html - sis-site - Git at Google

 <!DOCTYPE HTML>
 <!-- NewPage -->
 <html lang="en">
 <head>
 <!-- Generated by javadoc (11.0.4) on Fri Sep 20 12:10:30 CEST 2019 -->
 <title>ProbeResult (Apache SIS 1.0 API)</title>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <meta name="dc.created" content="2019-09-20">
 <meta name="keywords" content="org.apache.sis.storage.ProbeResult class">
 <meta name="keywords" content="SUPPORTED">
 <meta name="keywords" content="UNSUPPORTED_STORAGE">
 <meta name="keywords" content="INSUFFICIENT_BYTES">
 <meta name="keywords" content="UNDETERMINED">
 <meta name="keywords" content="isSupported()">
 <meta name="keywords" content="getMimeType()">
 <meta name="keywords" content="getVersion()">
 <meta name="keywords" content="hashCode()">
 <meta name="keywords" content="equals()">
 <meta name="keywords" content="toString()">
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../../sis.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
 <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
 <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
 <!--[if IE]>
 <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
 <![endif]-->
 <script type="text/javascript" src="../../../../jquery/jquery-3.3.1.js"></script>
 <script type="text/javascript" src="../../../../jquery/jquery-migrate-3.0.1.js"></script>
 <script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
             parent.document.title="ProbeResult (Apache SIS 1.0 API)";
         }
     }
     catch(err) {
     }
 //-->
 var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10};
 var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
 var altColor = "altColor";
 var rowColor = "rowColor";
 var tableTab = "tableTab";
 var activeTableTab = "activeTableTab";
 var pathtoroot = "../../../../";
 var useModuleDirectories = false;
 loadScripts(document, 'script');</script>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 <header role="banner">
 <nav role="navigation">
 <div class="fixedNav">
 <!-- ========= START OF TOP NAVBAR ======= -->
 <div class="topNav"><a id="navbar.top">
 <!--   -->
 </a>
 <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
 <a id="navbar.top.firstrow">
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
 <li><a href="../../../../index.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="navBarCell1Rev">Class</li>
 <li><a href="class-use/ProbeResult.html">Use</a></li>
 <li><a href="package-tree.html">Tree</a></li>
 <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
 <li><a href="../../../../index-all.html">Index</a></li>
 <li><a href="../../../../help-doc.html">Help</a></li>
 </ul>
 </div>
 <div class="subNav">
 <ul class="navList" id="allclasses_navbar_top">
 <li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
 </ul>
 <ul class="navListSearch">
 <li><label for="search">SEARCH:</label>
 <input type="text" id="search" value="search" disabled="disabled">
 <input type="reset" id="reset" value="reset" disabled="disabled">
 </li>
 </ul>
 <div>
 <script type="text/javascript"><!--
   allClassesLink = document.getElementById("allclasses_navbar_top");
   if(window==top) {
     allClassesLink.style.display = "block";
   }
   else {
     allClassesLink.style.display = "none";
   }
   //-->
 </script>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 </div>
 <div>
 <ul class="subNavList">
 <li>Summary:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
 <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method.detail">Method</a></li>
 </ul>
 </div>
 <a id="skip.navbar.top">
 <!--   -->
 </a></div>
 <!-- ========= END OF TOP NAVBAR ========= -->
 </div>
 <div class="navPadding">&nbsp;</div>
 <script type="text/javascript"><!--
 $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
 //-->
 </script>
 </nav>
 </header>
 <!-- ======== START OF CLASS DATA ======== -->
 <main role="main">
 <div class="header">
 <div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.sis.storage</a></div>
 <h2 title="Class ProbeResult" class="title">Class ProbeResult</h2>
 </div>
 <div class="contentContainer">
 <ul class="inheritance">
 <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></li>
 <li>
 <ul class="inheritance">
 <li>ProbeResult</li>
 </ul>
 </li>
 </ul>
 <div class="description">
 <ul class="blockList">
 <li class="blockList">
 <dl>
 <dt>All Implemented Interfaces:</dt>
 <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io" class="externalLink">Serializable</a></code></dd>
 </dl>
 <hr>
 <pre>public class <span class="typeNameLabel">ProbeResult</span>
 extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>
 implements <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io" class="externalLink">Serializable</a></pre>
 <div class="block">Tells whether a storage (file, database) appears to be supported by a <code>DataStore</code>.
  <code>ProbeResult</code> may also provide additional information, like file MIME type and the
  format version.

  <div class="section">Usage</div>
  When a <a href="DataStores.html#open(java.lang.Object)"><code>DataStores.open(…)</code></a> method is invoked, SIS will iterate over the list of known
  providers and invoke the <a href="DataStoreProvider.html#probeContent(org.apache.sis.storage.StorageConnector)"><code>DataStoreProvider.probeContent(StorageConnector)</code></a> method for each of them.
  The <code>ProbeResult</code> value returned by <code>probeContent(…)</code> tells to SIS whether a particular
  <code>DataStoreProvider</code> instance has reasonable chances to be able to handle the given storage.

  <p>Whether a storage appears to be supported or not is given by the <a href="#isSupported()"><code>isSupported()</code></a> property.
  Other properties like <a href="#getVersion()"><code>getVersion()</code></a> are sometime available for both supported and unsupported storages.
  For example a file may be encoded in a known format, but may be using an unsupported version of that format.</p>

  <div class="section">Special values</div>
  In addition to the supported/unsupported information, <code>ProbeResult</code> defines two constants having
  a special meaning: <a href="#INSUFFICIENT_BYTES"><code>INSUFFICIENT_BYTES</code></a> and <a href="#UNDETERMINED"><code>UNDETERMINED</code></a>, which indicate that the provider does
  not have enough information for telling whether the storage can be opened.
  In such cases, SIS will revisit those providers only if no better suited provider is found.</div>
 <dl>
 <dt><span class="simpleTagLabel">Since:</span></dt>
 <dd>0.4</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="DataStoreProvider.html#probeContent(org.apache.sis.storage.StorageConnector)"><code>DataStoreProvider.probeContent(StorageConnector)</code></a>,
 <a href="../../../../serialized-form.html#org.apache.sis.storage.ProbeResult">Serialized Form</a></dd>

 <p><font size="-1">Defined in the <code>sis-storage</code> module</font></p>
 </dl>
 </li>
 </ul>
 </div>
 <div class="summary">
 <ul class="blockList">
 <li class="blockList">
 <!-- =========== FIELD SUMMARY =========== -->
 <section role="region">
 <ul class="blockList">
 <li class="blockList"><a id="field.summary">
 <!--   -->
 </a>
 <h3>Field Summary</h3>
 <table class="memberSummary">
 <caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
 <tr>
 <th class="colFirst" scope="col">Modifier and Type</th>
 <th class="colSecond" scope="col">Field</th>
 <th class="colLast" scope="col">Description</th>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>static <a href="ProbeResult.html" title="class in org.apache.sis.storage">ProbeResult</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#INSUFFICIENT_BYTES">INSUFFICIENT_BYTES</a></span></code></th>
 <td class="colLast">
 <div class="block">The open capability can not be determined because the <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio" class="externalLink"><code>ByteBuffer</code></a> contains an insufficient
  amount of bytes.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>static <a href="ProbeResult.html" title="class in org.apache.sis.storage">ProbeResult</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#SUPPORTED">SUPPORTED</a></span></code></th>
 <td class="colLast">
 <div class="block">The <code>DataStoreProvider</code> recognizes the given storage, but has no additional information.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>static <a href="ProbeResult.html" title="class in org.apache.sis.storage">ProbeResult</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#UNDETERMINED">UNDETERMINED</a></span></code></th>
 <td class="colLast">
 <div class="block">The open capability can not be determined.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>static <a href="ProbeResult.html" title="class in org.apache.sis.storage">ProbeResult</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#UNSUPPORTED_STORAGE">UNSUPPORTED_STORAGE</a></span></code></th>
 <td class="colLast">
 <div class="block">The <code>DataStoreProvider</code> does not recognize the given storage object, file format or database schema.</div>
 </td>
 </tr>
 </table>
 </li>
 </ul>
 </section>
 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 <section role="region">
 <ul class="blockList">
 <li class="blockList"><a id="constructor.summary">
 <!--   -->
 </a>
 <h3>Constructor Summary</h3>
 <table class="memberSummary">
 <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
 <tr>
 <th class="colFirst" scope="col">Constructor</th>
 <th class="colLast" scope="col">Description</th>
 </tr>
 <tr class="altColor">
 <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(boolean,java.lang.String,org.apache.sis.util.Version)">ProbeResult</a></span>&#8203;(boolean&nbsp;isSupported,
            <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;mimeType,
            <a href="../util/Version.html" title="class in org.apache.sis.util">Version</a>&nbsp;version)</code></th>
 <td class="colLast">
 <div class="block">Creates a new <code>ProbeResult</code> with the given support status, MIME type and version number.</div>
 </td>
 </tr>
 </table>
 </li>
 </ul>
 </section>
 <!-- ========== METHOD SUMMARY =========== -->
 <section role="region">
 <ul class="blockList">
 <li class="blockList"><a id="method.summary">
 <!--   -->
 </a>
 <h3>Method Summary</h3>
 <table class="memberSummary">
 <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
 <tr>
 <th class="colFirst" scope="col">Modifier and Type</th>
 <th class="colSecond" scope="col">Method</th>
 <th class="colLast" scope="col">Description</th>
 </tr>
 <tr id="i0" class="altColor">
 <td class="colFirst"><code>boolean</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#equals(java.lang.Object)">equals</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;object)</code></th>
 <td class="colLast">
 <div class="block">Compares this <code>ProbeResult</code> with the given object for equality.</div>
 </td>
 </tr>
 <tr id="i1" class="rowColor">
 <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMimeType()">getMimeType</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Returns the MIME type of the storage file format, or <code>null</code> if unknown or not applicable.</div>
 </td>
 </tr>
 <tr id="i2" class="altColor">
 <td class="colFirst"><code><a href="../util/Version.html" title="class in org.apache.sis.util">Version</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getVersion()">getVersion</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Returns the version of file format or database schema used by the storage,
  or <code>null</code> if unknown or not applicable.</div>
 </td>
 </tr>
 <tr id="i3" class="rowColor">
 <td class="colFirst"><code>int</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hashCode()">hashCode</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Returns a hash code value for this instance.</div>
 </td>
 </tr>
 <tr id="i4" class="altColor">
 <td class="colFirst"><code>boolean</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isSupported()">isSupported</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Returns <code>true</code> if the storage is supported by the <code>DataStoreProvider</code>.</div>
 </td>
 </tr>
 <tr id="i5" class="rowColor">
 <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Returns a string representation of this <code>ProbeResult</code> for debugging purpose.</div>
 </td>
 </tr>
 </table>
 <ul class="blockList">
 <li class="blockList"><a id="methods.inherited.from.class.Object">
 <!--   -->
 </a>
 <h3>Methods inherited from class&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3>
 <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li>
 </ul>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </div>
 <div class="details">
 <ul class="blockList">
 <li class="blockList">
 <!-- ============ FIELD DETAIL =========== -->
 <section role="region">
 <ul class="blockList">
 <li class="blockList"><a id="field.detail">
 <!--   -->
 </a>
 <h3>Field Detail</h3>
 <a id="SUPPORTED">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>SUPPORTED</h4>
 <pre>public static final&nbsp;<a href="ProbeResult.html" title="class in org.apache.sis.storage">ProbeResult</a> SUPPORTED</pre>
 <div class="block">The <code>DataStoreProvider</code> recognizes the given storage, but has no additional information.
  The <a href="#isSupported()"><code>isSupported()</code></a> method returns <code>true</code>, but the <a href="#getMimeType()">MIME type</a>
  and <a href="#getVersion()">version</a> properties are <code>null</code>.

  <p><a href="DataStoreProvider.html#probeContent(org.apache.sis.storage.StorageConnector)"><code>DataStoreProvider.probeContent(StorageConnector)</code></a> implementations should consider returning a
  <a href="#%3Cinit%3E(boolean,java.lang.String,org.apache.sis.util.Version)">new instance</a> instead than this constant
  if they can provide the file MIME type or the format version number.</p></div>
 </li>
 </ul>
 <a id="UNSUPPORTED_STORAGE">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>UNSUPPORTED_STORAGE</h4>
 <pre>public static final&nbsp;<a href="ProbeResult.html" title="class in org.apache.sis.storage">ProbeResult</a> UNSUPPORTED_STORAGE</pre>
 <div class="block">The <code>DataStoreProvider</code> does not recognize the given storage object, file format or database schema.
  No other information is available: the <a href="#isSupported()"><code>isSupported()</code></a> method returns <code>false</code>, and the
  <a href="#getMimeType()">MIME type</a> and <a href="#getVersion()">version</a> properties are <code>null</code>.

  <p>Examples:</p>
  <ul>
    <li>The storage is a file while the provider expected a database connection (or conversely).</li>
    <li>The file does not contains the expected magic number.</li>
    <li>The database schema does not contain the expected tables.</li>
  </ul>

  <a href="DataStoreProvider.html#probeContent(org.apache.sis.storage.StorageConnector)"><code>DataStoreProvider.probeContent(StorageConnector)</code></a> implementations should consider returning a
  <a href="#%3Cinit%3E(boolean,java.lang.String,org.apache.sis.util.Version)">new instance</a> instead than this constant
  if the <code>DataStoreProvider</code> recognizes the given storage, but the data are structured
  according a file or schema version not yet supported by the current implementation.</div>
 </li>
 </ul>
 <a id="INSUFFICIENT_BYTES">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>INSUFFICIENT_BYTES</h4>
 <pre>public static final&nbsp;<a href="ProbeResult.html" title="class in org.apache.sis.storage">ProbeResult</a> INSUFFICIENT_BYTES</pre>
 <div class="block">The open capability can not be determined because the <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio" class="externalLink"><code>ByteBuffer</code></a> contains an insufficient
  amount of bytes. This value can be returned by <a href="DataStoreProvider.html#probeContent(org.apache.sis.storage.StorageConnector)"><code>DataStoreProvider.probeContent(StorageConnector)</code></a>
  implementations as below:

  <blockquote><pre><font color="green">public</font> ProbeResult <b>probeContent</b>(StorageConnector storage) <font color="green">throws</font> DataStoreException {
     <font color="green">final</font> ByteBuffer buffer = storage.<b>getStorageAs</b>(ByteBuffer.<font color="green">class</font>);
     <font color="green">if</font> (buffer == <font color="green">null</font>) {
         <font color="green">return</font> ProbeResult.UNSUPPORTED_STORAGE;
     }
     <font color="green">if</font> (buffer.<b>remaining</b>() &lt; Integer.BYTES) {
         <font color="green">return</font> ProbeResult.INSUFFICIENT_BYTES;
     }
     <i><font color="gray">// Other verifications here.</font></i>
 }</pre></blockquote>

  When searching for a provider capable to read a given file,
  if at least one <code>DataStoreProvider</code> returns <code>INSUFFICIENT_BYTES</code>, then:

  <ol>
    <li>SIS will continue to search for an other provider for which <code>probeContent(…)</code>
        declares to support the storage, using only the available bytes.</li>
    <li>Only if no such provider can be found, then SIS will fetch more bytes and query again
        the providers that returned <code>INSUFFICIENT_BYTES</code> in the previous iteration.</li>
  </ol>

  SIS tries to work with available bytes before to ask more in order to reduce latencies on network connections.</div>
 </li>
 </ul>
 <a id="UNDETERMINED">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>UNDETERMINED</h4>
 <pre>public static final&nbsp;<a href="ProbeResult.html" title="class in org.apache.sis.storage">ProbeResult</a> UNDETERMINED</pre>
 <div class="block">The open capability can not be determined.
  This value may be returned by <code>DataStore</code> implementations that could potentially open anything,
  for example the RAW image format.

  <p><strong>This is a last resort value!</strong> <code>probeContent(…)</code> implementations are strongly encouraged
  to return a more accurate enumeration value for allowing <a href="DataStores.html#open(java.lang.Object)"><code>DataStores.open(Object)</code></a> to perform a better
  choice. Generally, this value should be returned only by the RAW image format.</p></div>
 </li>
 </ul>
 </li>
 </ul>
 </section>
 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 <section role="region">
 <ul class="blockList">
 <li class="blockList"><a id="constructor.detail">
 <!--   -->
 </a>
 <h3>Constructor Detail</h3>
 <a id="&lt;init&gt;(boolean,java.lang.String,org.apache.sis.util.Version)">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>ProbeResult</h4>
 <pre>public&nbsp;ProbeResult&#8203;(boolean&nbsp;isSupported,
                    <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;mimeType,
                    <a href="../util/Version.html" title="class in org.apache.sis.util">Version</a>&nbsp;version)</pre>
 <div class="block">Creates a new <code>ProbeResult</code> with the given support status, MIME type and version number.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>isSupported</code> - <code>true</code> if the storage is supported by the <a href="DataStoreProvider.html" title="class in org.apache.sis.storage"><code>DataStoreProvider</code></a>.</dd>
 <dd><code>mimeType</code> - the storage MIME type, or <code>null</code> if unknown or not applicable.</dd>
 <dd><code>version</code> - the version of file format or database schema used by the storage,
                      or <code>null</code> if unknown or not applicable.</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 </section>
 <!-- ============ METHOD DETAIL ========== -->
 <section role="region">
 <ul class="blockList">
 <li class="blockList"><a id="method.detail">
 <!--   -->
 </a>
 <h3>Method Detail</h3>
 <a id="isSupported()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>isSupported</h4>
 <pre class="methodSignature">public&nbsp;boolean&nbsp;isSupported()</pre>
 <div class="block">Returns <code>true</code> if the storage is supported by the <code>DataStoreProvider</code>.
  <code>DataStore</code> instances created by that provider are likely (but not guaranteed)
  to be able to read from - and eventually write to - the given storage.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd><code>true</code> if the storage is supported by the <a href="DataStoreProvider.html" title="class in org.apache.sis.storage"><code>DataStoreProvider</code></a>.</dd>
 </dl>
 </li>
 </ul>
 <a id="getMimeType()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getMimeType</h4>
 <pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;getMimeType()</pre>
 <div class="block">Returns the MIME type of the storage file format, or <code>null</code> if unknown or not applicable.
  The <a href="DataStoreProvider.html" title="class in org.apache.sis.storage"><code>DataStoreProvider</code></a> may (at implementation choice) inspect the storage content for
  determining a more accurate MIME type.

  <div class="section">XML types</div>
  A generic MIME type for XML documents is <code>"application/xml"</code>.
  However many other MIME types exist for XML documents compliant to some particular shema.
  Those types can be determined by inspecting the namespace of XML root element.
  The following table gives some example:

  <table class="sis">
  <caption>MIME type examples</caption>
    <tr><th>MIME type</th>                                                    <th>Description</th>                                 <th>Namespace</th></tr>
    <tr><td><code>"application/gml+xml"</code></td>                                <td>Official mime type for OGC GML</td>              <td><a href="../xml/Namespaces.html#GML">"http://www.opengis.net/gml/3.2"</a></td></tr>
    <tr><td><code>"application/vnd.eu.europa.ec.inspire.resource+xml"</code></td>  <td>Official mime type for INSPIRE Resources</td>    <td></td></tr>
    <tr><td><code>"application/vnd.iso.19139+xml"</code></td>                      <td>Unofficial mime type for ISO 19139 metadata</td> <td><a href="../xml/Namespaces.html#GMD">"http://www.isotc211.org/2005/gmd"</a></td></tr>
    <tr><td><code>"application/vnd.ogc.wms_xml"</code></td>                        <td>Unofficial mime type for OGC WMS</td>            <td></td></tr>
    <tr><td><code>"application/vnd.ogc.wfs_xml"</code></td>                        <td>Unofficial mime type for OGC WFS </td>           <td></td></tr>
    <tr><td><code>"application/vnd.ogc.csw_xml"</code></td>                        <td>Unofficial mime type for OGC CSW</td>            <td><a href="../xml/Namespaces.html#CSW">"http://www.opengis.net/cat/csw/3.0"</a></td></tr>
    <tr><td><code>"application/vnd.google-earth.kml+xml"</code></td>               <td></td><td></td></tr>
    <tr><td><code>"application/rdf+xml"</code></td>                                <td></td><td></td></tr>
    <tr><td><code>"application/soap+xml"</code></td>                               <td></td><td></td></tr>
  </table></div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the storage MIME type, or <code>null</code> if unknown or not applicable.</dd>
 </dl>
 </li>
 </ul>
 <a id="getVersion()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getVersion</h4>
 <pre class="methodSignature">public&nbsp;<a href="../util/Version.html" title="class in org.apache.sis.util">Version</a>&nbsp;getVersion()</pre>
 <div class="block">Returns the version of file format or database schema used by the storage,
  or <code>null</code> if unknown or not applicable.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the version of file format or database schema used by the storage,
          or <code>null</code> if unknown or not applicable.</dd>
 </dl>
 </li>
 </ul>
 <a id="hashCode()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>hashCode</h4>
 <pre class="methodSignature">public&nbsp;int&nbsp;hashCode()</pre>
 <div class="block">Returns a hash code value for this instance.</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
 <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd>
 </dl>
 </li>
 </ul>
 <a id="equals(java.lang.Object)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>equals</h4>
 <pre class="methodSignature">public&nbsp;boolean&nbsp;equals&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;object)</pre>
 <div class="block">Compares this <code>ProbeResult</code> with the given object for equality.
  Two <code>ProbeResult</code>s are equal if they are instances of the same class
  and all their properties are equal.</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
 <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>object</code> - the object to compare with this <code>ProbeResult</code>.</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd><code>true</code> if the two objects are equal.</dd>
 </dl>
 </li>
 </ul>
 <a id="toString()">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>toString</h4>
 <pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;toString()</pre>
 <div class="block">Returns a string representation of this <code>ProbeResult</code> for debugging purpose.</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
 <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </div>
 </div>
 </main>
 <!-- ========= END OF CLASS DATA ========= -->
 <footer role="contentinfo">
 <nav role="navigation">
 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 <div class="bottomNav"><a id="navbar.bottom">
 <!--   -->
 </a>
 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
 <a id="navbar.bottom.firstrow">
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
 <li><a href="../../../../index.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="navBarCell1Rev">Class</li>
 <li><a href="class-use/ProbeResult.html">Use</a></li>
 <li><a href="package-tree.html">Tree</a></li>
 <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
 <li><a href="../../../../index-all.html">Index</a></li>
 <li><a href="../../../../help-doc.html">Help</a></li>
 </ul>
 </div>
 <div class="subNav">
 <ul class="navList" id="allclasses_navbar_bottom">
 <li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
 </ul>
 <div>
 <script type="text/javascript"><!--
   allClassesLink = document.getElementById("allclasses_navbar_bottom");
   if(window==top) {
     allClassesLink.style.display = "block";
   }
   else {
     allClassesLink.style.display = "none";
   }
   //-->
 </script>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 </div>
 <div>
 <ul class="subNavList">
 <li>Summary:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
 <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method.detail">Method</a></li>
 </ul>
 </div>
 <a id="skip.navbar.bottom">
 <!--   -->
 </a></div>
 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 </nav>
 <p class="legalCopy"><small>Copyright &#169; 2010&#x2013;2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
 </footer>
 </body>
 </html>