Loader_8java_source.html 17.1 KB
Newer Older
Valentin Platzgummer's avatar
Valentin Platzgummer committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
    <head>
        <title>OR-Tools</title>
        <meta http-equiv="Content-Type" content="text/html;"/>
        <meta charset="utf-8"/>
        <!--<link rel='stylesheet' type='text/css' href="https://fonts.googleapis.com/css?family=Ubuntu:400,700,400italic"/>-->
        <script type="text/javascript" src="jquery.js"></script>
        <script type="text/javascript" src="dynsections.js"></script>
        <link href="doxygen.css" rel="stylesheet" type="text/css" />
        <link href="styleSheet.tmp.css" rel="stylesheet" type="text/css"/>
    </head>
    <body>
        <div id="banner-container">
            <div id="banner">
                <span id="sfml">Google OR-Tools 8.1</span>
            </div>
        </div>
        <div id="content" style="width: 100%; overflow: hidden;">
        <div style="margin-left: 15px; margin-top: 5px; float: left; color: #145A32;">
        <h2>Java Reference</h2>
        <ul>
          <li><a href="../java/namespacecom_1_1google_1_1ortools_1_1sat.html">CP-SAT</a></li>
          <li><a href="../java/namespacecom_1_1google_1_1ortools_1_1graph.html">Graph</a></li>
          <li><a href="../java/namespacecom_1_1google_1_1ortools_1_1algorithms.html">Knapsack solver</a></li>
          <li><a href="../java/namespacecom_1_1google_1_1ortools_1_1linearsolver.html">Linear solver</a></li>
          <li><a href="../java/namespacecom_1_1google_1_1ortools_1_1constraintsolver.html">Routing</a></li>
          <li><a href="../java/namespacecom_1_1google_1_1ortools_1_1util.html">Util</a></li>
        </ul>
        </div>
        <div id="content">
            <div align="center">
                <h1 style="color: #145A32;">Java Reference</h1>
            </div>
<!-- Generated by Doxygen 1.8.20 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('Loader_8java_source.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="headertitle">
<div class="title">Loader.java</div>  </div>
</div><!--header-->
<div class="contents">
<a href="Loader_8java.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="keyword">package </span>com.google.ortools;</div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160; </div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="keyword">import</span> <a class="code" href="namespacecom.html">com</a>.sun.jna.Platform;</div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="keyword">import</span> java.io.IOException;</div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="keyword">import</span> java.net.URI;</div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="keyword">import</span> java.net.URISyntaxException;</div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="keyword">import</span> java.net.URL;</div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="keyword">import</span> java.nio.file.FileSystem;</div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="keyword">import</span> java.nio.file.FileSystems;</div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="keyword">import</span> java.nio.file.FileVisitResult;</div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="keyword">import</span> java.nio.file.Files;</div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="keyword">import</span> java.nio.file.Path;</div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="keyword">import</span> java.nio.file.SimpleFileVisitor;</div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="keyword">import</span> java.nio.file.attribute.BasicFileAttributes;</div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="keyword">import</span> java.util.Collections;</div>
<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="keyword">import</span> java.util.Objects;</div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160; </div>
<div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="classcom_1_1google_1_1ortools_1_1Loader.html">   19</a></span>&#160;<span class="keyword">public</span> <span class="keyword">class </span><a class="code" href="classcom_1_1google_1_1ortools_1_1Loader.html">Loader</a> {</div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;  <span class="keyword">private</span> <span class="keyword">static</span> URI getNativeResourceURI() <span class="keywordflow">throws</span> IOException {</div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;    ClassLoader loader = <a class="code" href="classcom_1_1google_1_1ortools_1_1Loader.html">Loader</a>.class.getClassLoader();</div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;    String resource = Platform.RESOURCE_PREFIX + <span class="stringliteral">&quot;/&quot;</span>;</div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;    URL resourceURL = loader.getResource(resource);</div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;    Objects.requireNonNull(resourceURL,</div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;        String.format(<span class="stringliteral">&quot;Resource %s was not found in ClassLoader %s&quot;</span>, resource, loader));</div>
<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160; </div>
<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;    URI resourceURI;</div>
<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;    <span class="keywordflow">try</span> {</div>
<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;      resourceURI = resourceURL.toURI();</div>
<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;    } <span class="keywordflow">catch</span> (URISyntaxException e) {</div>
<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;      <span class="keywordflow">throw</span> <span class="keyword">new</span> IOException(e);</div>
<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;    }</div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;    <span class="keywordflow">return</span> resourceURI;</div>
<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;  }</div>
<div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160; </div>
<div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;  @FunctionalInterface</div>
<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;  <span class="keyword">private</span> <span class="keyword">interface </span>PathConsumer&lt;T <span class="keyword">extends</span> IOException&gt; {</div>
<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;    <span class="keywordtype">void</span> accept(Path path) <span class="keywordflow">throws</span> T;</div>
<div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;  }</div>
<div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160; </div>
<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;  <span class="keyword">private</span> <span class="keyword">static</span> Path unpackNativeResources(URI resourceURI) <span class="keywordflow">throws</span> IOException {</div>
<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;    Path tempPath;</div>
<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;    tempPath = Files.createTempDirectory(<span class="stringliteral">&quot;ortools-java&quot;</span>);</div>
<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;    tempPath.toFile().deleteOnExit();</div>
<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160; </div>
<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;    PathConsumer&lt;?&gt; visitor;</div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;    visitor = (Path sourcePath) -&gt; Files.walkFileTree(sourcePath, <span class="keyword">new</span> SimpleFileVisitor&lt;Path&gt;() {</div>
<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;      @Override</div>
<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;      <span class="keyword">public</span> FileVisitResult visitFile(Path file, BasicFileAttributes attrs) <span class="keywordflow">throws</span> IOException {</div>
<div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;        Path newPath = tempPath.resolve(sourcePath.getParent().relativize(file).toString());</div>
<div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;        Files.copy(file, newPath);</div>
<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;        newPath.toFile().deleteOnExit();</div>
<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;        <span class="keywordflow">return</span> FileVisitResult.CONTINUE;</div>
<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;      }</div>
<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160; </div>
<div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;      @Override</div>
<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;      <span class="keyword">public</span> FileVisitResult preVisitDirectory(Path dir, BasicFileAttributes attrs)</div>
<div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;          <span class="keywordflow">throws</span> IOException {</div>
<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;        Path newPath = tempPath.resolve(sourcePath.getParent().relativize(dir).toString());</div>
<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;        Files.copy(dir, newPath);</div>
<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;        newPath.toFile().deleteOnExit();</div>
<div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;        <span class="keywordflow">return</span> FileVisitResult.CONTINUE;</div>
<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;      }</div>
<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;    });</div>
<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160; </div>
<div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;    FileSystem fs = FileSystems.newFileSystem(resourceURI, Collections.emptyMap());</div>
<div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;    Path p = fs.provider().getPath(resourceURI);</div>
<div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;    visitor.accept(p);</div>
<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;    <span class="keywordflow">return</span> tempPath;</div>
<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;  }</div>
<div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160; </div>
<div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;  <span class="keyword">private</span> <span class="keyword">static</span> <span class="keywordtype">boolean</span> loaded = <span class="keyword">false</span>;</div>
<div class="line"><a name="l00080"></a><span class="lineno"><a class="line" href="classcom_1_1google_1_1ortools_1_1Loader.html#a9a2f42e70e4614116cbb84ce99984e4a">   80</a></span>&#160;  <span class="keyword">public</span> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classcom_1_1google_1_1ortools_1_1Loader.html#a9a2f42e70e4614116cbb84ce99984e4a">loadNativeLibraries</a>() {</div>
<div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;    <span class="keywordflow">if</span> (!loaded) {</div>
<div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;      <span class="keywordflow">try</span> {</div>
<div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;        URI resourceURI = getNativeResourceURI();</div>
<div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;        Path tempPath = unpackNativeResources(resourceURI);</div>
<div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;        <span class="comment">// Load the native library</span></div>
<div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;        System.load(tempPath.resolve(Platform.RESOURCE_PREFIX)</div>
<div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;                        .resolve(System.mapLibraryName(<span class="stringliteral">&quot;jniortools&quot;</span>))</div>
<div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;                        .toString());</div>
<div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;        loaded = <span class="keyword">true</span>;</div>
<div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;      } <span class="keywordflow">catch</span> (IOException e) {</div>
<div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;        <span class="keywordflow">throw</span> <span class="keyword">new</span> RuntimeException(e);</div>
<div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;      }</div>
<div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;    }</div>
<div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;  }</div>
<div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;}</div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1Loader_html_a9a2f42e70e4614116cbb84ce99984e4a"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1Loader.html#a9a2f42e70e4614116cbb84ce99984e4a">com.google.ortools.Loader.loadNativeLibraries</a></div><div class="ttdeci">static void loadNativeLibraries()</div><div class="ttdef"><b>Definition:</b> <a href="Loader_8java_source.html#l00080">Loader.java:80</a></div></div>
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1Loader_html"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1Loader.html">com.google.ortools.Loader</a></div><div class="ttdoc">Load native libraries needed for using ortools-java.</div><div class="ttdef"><b>Definition:</b> <a href="Loader_8java_source.html#l00019">Loader.java:19</a></div></div>
<div class="ttc" id="anamespacecom_html"><div class="ttname"><a href="namespacecom.html">com</a></div></div>
        </div>
        </div>
        <div id="footer-container">
            <div id="footer">
            </div>
        </div>
    </body>
</html>