Files
ortools-clone/docs/java/Loader_8java_source.html

209 lines
21 KiB
HTML
Raw Normal View History

2020-09-02 09:42:51 +02:00
<!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">
2021-09-20 15:57:27 +02:00
<span id="sfml">Google OR-Tools 9.1</span>
2020-09-02 09:42:51 +02:00
</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>
2021-09-30 01:18:45 +02:00
<!-- Generated by Doxygen 1.9.2 -->
2020-09-02 09:42:51 +02:00
<script type="text/javascript">
2021-09-30 01:18:45 +02:00
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
2020-09-02 09:42:51 +02:00
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
2021-09-30 01:18:45 +02:00
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
2020-09-02 09:42:51 +02:00
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
2021-09-30 01:18:45 +02:00
/* @license-end */
</script>
2020-09-02 09:42:51 +02:00
<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">
2021-09-30 01:18:45 +02:00
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('Loader_8java_source.html',''); initResizable(); });
2020-09-02 09:42:51 +02:00
/* @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">
2021-09-30 01:18:45 +02:00
<div class="headertitle"><div class="title">Loader.java</div></div>
2020-09-02 09:42:51 +02:00
</div><!--header-->
<div class="contents">
2021-09-30 01:18:45 +02:00
<a href="Loader_8java.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">// Copyright 2010-2021 Google LLC</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment">// you may not use this file except in compliance with the License.</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment">// You may obtain a copy of the License at</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment">//</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment">//</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment">// Unless required by applicable law or agreed to in writing, software</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment">// distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment">// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment">// See the License for the specific language governing permissions and</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment">// limitations under the License.</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> </div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="keyword">package </span>com.google.ortools;</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> </div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="keyword">import</span> com.sun.jna.Platform;</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="keyword">import</span> java.io.IOException;</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="keyword">import</span> java.net.URI;</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="keyword">import</span> java.net.URISyntaxException;</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="keyword">import</span> java.net.URL;</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="keyword">import</span> java.nio.file.FileSystem;</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="keyword">import</span> java.nio.file.FileSystemAlreadyExistsException;</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="keyword">import</span> java.nio.file.FileSystems;</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="keyword">import</span> java.nio.file.FileVisitResult;</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="keyword">import</span> java.nio.file.Files;</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="keyword">import</span> java.nio.file.Path;</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="keyword">import</span> java.nio.file.SimpleFileVisitor;</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="keyword">import</span> java.nio.file.attribute.BasicFileAttributes;</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="keyword">import</span> java.util.Collections;</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="keyword">import</span> java.util.Objects;</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="classcom_1_1google_1_1ortools_1_1Loader.html"> 33</a></span><span class="keyword">public</span> <span class="keyword">class </span><a class="code hl_class" href="classcom_1_1google_1_1ortools_1_1Loader.html">Loader</a> {</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">private</span> <span class="keyword">static</span> <span class="keyword">final</span> String RESOURCE_PATH = <span class="stringliteral">&quot;ortools-&quot;</span> + Platform.RESOURCE_PREFIX + <span class="stringliteral">&quot;/&quot;</span>;</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> </div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">private</span> <span class="keyword">static</span> URI getNativeResourceURI() <span class="keywordflow">throws</span> IOException {</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> ClassLoader loader = <a class="code hl_class" href="classcom_1_1google_1_1ortools_1_1Loader.html">Loader</a>.class.getClassLoader();</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> URL resourceURL = loader.getResource(RESOURCE_PATH);</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> Objects.requireNonNull(resourceURL,</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> String.format(<span class="stringliteral">&quot;Resource %s was not found in ClassLoader %s&quot;</span>, RESOURCE_PATH, loader));</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> </div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> URI resourceURI;</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <span class="keywordflow">try</span> {</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> resourceURI = resourceURL.toURI();</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> } <span class="keywordflow">catch</span> (URISyntaxException e) {</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <span class="keywordflow">throw</span> <span class="keyword">new</span> IOException(e);</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> }</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <span class="keywordflow">return</span> resourceURI;</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> }</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> </div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> @FunctionalInterface</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> <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 id="l00054" name="l00054"></a><span class="lineno"> 54</span> <span class="keywordtype">void</span> accept(Path path) <span class="keywordflow">throws</span> T;</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> }</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> </div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> <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 id="l00063" name="l00063"></a><span class="lineno"> 63</span> Path tempPath;</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> tempPath = Files.createTempDirectory(<span class="stringliteral">&quot;ortools-java&quot;</span>);</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> tempPath.toFile().deleteOnExit();</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> </div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> PathConsumer&lt;?&gt; visitor;</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> visitor = (Path sourcePath) -&gt; Files.walkFileTree(sourcePath, <span class="keyword">new</span> SimpleFileVisitor&lt;Path&gt;() {</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> @Override</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> <span class="keyword">public</span> FileVisitResult visitFile(Path file, BasicFileAttributes attrs) <span class="keywordflow">throws</span> IOException {</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> Path newPath = tempPath.resolve(sourcePath.getParent().relativize(file).toString());</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> Files.copy(file, newPath);</div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> newPath.toFile().deleteOnExit();</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> <span class="keywordflow">return</span> FileVisitResult.CONTINUE;</div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> }</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> </div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> @Override</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> <span class="keyword">public</span> FileVisitResult preVisitDirectory(Path dir, BasicFileAttributes attrs)</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> <span class="keywordflow">throws</span> IOException {</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> Path newPath = tempPath.resolve(sourcePath.getParent().relativize(dir).toString());</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> Files.copy(dir, newPath);</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> newPath.toFile().deleteOnExit();</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> <span class="keywordflow">return</span> FileVisitResult.CONTINUE;</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> }</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> });</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> </div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> FileSystem fs;</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> <span class="keywordflow">try</span> {</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> fs = FileSystems.newFileSystem(resourceURI, Collections.emptyMap());</div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> } <span class="keywordflow">catch</span> (FileSystemAlreadyExistsException e) {</div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> fs = FileSystems.getFileSystem(resourceURI);</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> <span class="keywordflow">if</span> (fs == <span class="keyword">null</span>) {</div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> <span class="keywordflow">throw</span> <span class="keyword">new</span> IllegalArgumentException();</div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> }</div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> }</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> Path p = fs.provider().getPath(resourceURI);</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> visitor.accept(p);</div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> <span class="keywordflow">return</span> tempPath;</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> }</div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> </div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> <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 id="l00103" name="l00103"></a><span class="lineno"><a class="line" href="classcom_1_1google_1_1ortools_1_1Loader.html#a9a2f42e70e4614116cbb84ce99984e4a"> 103</a></span> <span class="keyword">public</span> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classcom_1_1google_1_1ortools_1_1Loader.html#a9a2f42e70e4614116cbb84ce99984e4a">loadNativeLibraries</a>() {</div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> <span class="keywordflow">if</span> (!loaded) {</div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> <span class="keywordflow">try</span> {</div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> URI resourceURI = getNativeResourceURI();</div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> Path tempPath = unpackNativeResources(resourceURI);</div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> <span class="comment">// Load the native library</span></div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span> System.load(tempPath.resolve(RESOURCE_PATH)</div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> .resolve(System.mapLibraryName(<span class="stringliteral">&quot;jniortools&quot;</span>))</div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span> .toString());</div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span> loaded = <span class="keyword">true</span>;</div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> } <span class="keywordflow">catch</span> (IOException e) {</div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> <span class="keywordflow">throw</span> <span class="keyword">new</span> RuntimeException(e);</div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span> }</div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> }</div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span> }</div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span>}</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#l00033">Loader.java:33</a></div></div>
<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#l00103">Loader.java:103</a></div></div>
2020-09-02 09:42:51 +02:00
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
</div>
</div>
<div id="footer-container">
<div id="footer">
</div>
</div>
</body>
</html>