EpicKnarvik97/PlotSquared
EpicKnarvik97/PlotSquared
1
0
Fork 0
mirror of https://github.com/IntellectualSites/PlotSquared.git synced 2024-11-23 05:36:45 +01:00
Code Issues Projects Releases Wiki Activity
42c02b37bf
PlotSquared/doc/com/intellectualsites/translation/YamlTranslationFile.html

511 lines
25 KiB
HTML
Raw Normal View History

Moved folder
2014-11-16 11:14:40 +01:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="sv">
<head>
<!-- Generated by javadoc (version 1.7.0_67) on Sun Nov 16 11:09:53 CET 2014 -->
<title>YamlTranslationFile</title>
<meta name="date" content="2014-11-16">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title = "YamlTranslationFile";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../com/intellectualsites/translation/TranslationObject.html"
title="class in com.intellectualsites.translation"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/intellectualsites/translation/YamlTranslationFile.html" target="_top">Frames</a>
</li>
<li><a href="YamlTranslationFile.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All Classes</a></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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&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>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.intellectualsites.translation</div>
<h2 title="Class YamlTranslationFile" class="title">Class YamlTranslationFile</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../com/intellectualsites/translation/TranslationFile.html"
title="class in com.intellectualsites.translation">com.intellectualsites.translation.TranslationFile</a>
</li>
<li>
<ul class="inheritance">
<li>com.intellectualsites.translation.YamlTranslationFile</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">YamlTranslationFile</span>
extends <a href="../../../com/intellectualsites/translation/TranslationFile.html"
title="class in com.intellectualsites.translation">TranslationFile</a></pre>
<div class="block">The YAML implementation of TranslationFile
Relies heavily on SnakeYAML
</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0"
summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a
href="../../../com/intellectualsites/translation/YamlTranslationFile.html#YamlTranslationFile(java.io.File,%20com.intellectualsites.translation.TranslationLanguage,%20java.lang.String,%20com.intellectualsites.translation.TranslationManager)">YamlTranslationFile</a></strong>(java.io.File&nbsp;path,
<a href="../../../com/intellectualsites/translation/TranslationLanguage.html"
title="class in com.intellectualsites.translation">TranslationLanguage</a>&nbsp;language,
java.lang.String&nbsp;name,
<a href="../../../com/intellectualsites/translation/TranslationManager.html"
title="class in com.intellectualsites.translation">TranslationManager</a>&nbsp;manager)</code>
<div class="block">Constructor</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0"
summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a
href="../../../com/intellectualsites/translation/YamlTranslationFile.html#add(java.lang.String,%20java.lang.String)">add</a></strong>(java.lang.String&nbsp;key,
java.lang.String&nbsp;value)</code>
<div class="block">Add a translation</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a
href="../../../com/intellectualsites/translation/YamlTranslationFile.html"
title="class in com.intellectualsites.translation">YamlTranslationFile</a></code>
</td>
<td class="colLast"><code><strong><a
href="../../../com/intellectualsites/translation/YamlTranslationFile.html#fancyHeader(java.lang.String...)">fancyHeader</a></strong>(java.lang.String...&nbsp;header)</code>
<div class="block">Set a fancy header</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a
href="../../../com/intellectualsites/translation/TranslationLanguage.html"
title="class in com.intellectualsites.translation">TranslationLanguage</a></code>
</td>
<td class="colLast"><code><strong><a
href="../../../com/intellectualsites/translation/YamlTranslationFile.html#getLanguage()">getLanguage</a></strong>()</code>
<div class="block">Get the translation language</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>org.yaml.snakeyaml.Yaml</code></td>
<td class="colLast"><code><strong><a
href="../../../com/intellectualsites/translation/YamlTranslationFile.html#getYaml()">getYaml</a></strong>()</code>
<div class="block">Get the YAML object</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a
href="../../../com/intellectualsites/translation/YamlTranslationFile.html"
title="class in com.intellectualsites.translation">YamlTranslationFile</a></code>
</td>
<td class="colLast"><code><strong><a
href="../../../com/intellectualsites/translation/YamlTranslationFile.html#header(java.lang.String...)">header</a></strong>(java.lang.String...&nbsp;header)</code>
<div class="block">Set the header</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a
href="../../../com/intellectualsites/translation/YamlTranslationFile.html"
title="class in com.intellectualsites.translation">YamlTranslationFile</a></code>
</td>
<td class="colLast"><code><strong><a
href="../../../com/intellectualsites/translation/YamlTranslationFile.html#read()">read</a></strong>()</code>
<div class="block">Read the file</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a
href="../../../com/intellectualsites/translation/YamlTranslationFile.html#reload()">reload</a></strong>()</code>
<div class="block">Reload</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a
href="../../../com/intellectualsites/translation/YamlTranslationFile.html#saveFile()">saveFile</a></strong>()</code>
<div class="block">Save the file</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait,
wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="YamlTranslationFile(java.io.File, com.intellectualsites.translation.TranslationLanguage, java.lang.String, com.intellectualsites.translation.TranslationManager)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>YamlTranslationFile</h4>
<pre>public&nbsp;YamlTranslationFile(java.io.File&nbsp;path,
<a href="../../../com/intellectualsites/translation/TranslationLanguage.html"
title="class in com.intellectualsites.translation">TranslationLanguage</a>&nbsp;language,
java.lang.String&nbsp;name,
<a href="../../../com/intellectualsites/translation/TranslationManager.html"
title="class in com.intellectualsites.translation">TranslationManager</a>&nbsp;manager)</pre>
<div class="block">Constructor</div>
<dl>
<dt><span class="strong">Parameters:</span></dt>
<dd><code>path</code> - save path</dd>
<dd><code>language</code> - translation language</dd>
<dd><code>name</code> - project name</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="reload()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reload</h4>
<pre>public&nbsp;void&nbsp;reload()</pre>
<div class="block">Reload</div>
</li>
</ul>
<a name="header(java.lang.String...)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>header</h4>
<pre>public&nbsp;<a
href="../../../com/intellectualsites/translation/YamlTranslationFile.html"
title="class in com.intellectualsites.translation">YamlTranslationFile</a>&nbsp;header(java.lang.String...&nbsp;header)</pre>
<div class="block">Set the header</div>
<dl>
<dt><span class="strong">Parameters:</span></dt>
<dd><code>header</code> - Comment header</dd>
<dt><span class="strong">Returns:</span></dt>
<dd>instance</dd>
</dl>
</li>
</ul>
<a name="fancyHeader(java.lang.String...)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fancyHeader</h4>
<pre>public&nbsp;<a
href="../../../com/intellectualsites/translation/YamlTranslationFile.html"
title="class in com.intellectualsites.translation">YamlTranslationFile</a>&nbsp;fancyHeader(java.lang.String...&nbsp;header)</pre>
<div class="block">Set a fancy header</div>
<dl>
<dt><span class="strong">Parameters:</span></dt>
<dd><code>header</code> - Comment header</dd>
<dt><span class="strong">Returns:</span></dt>
<dd>instance</dd>
</dl>
</li>
</ul>
<a name="add(java.lang.String, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre>public&nbsp;void&nbsp;add(java.lang.String&nbsp;key,
java.lang.String&nbsp;value)</pre>
<div class="block">Add a translation</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a
href="../../../com/intellectualsites/translation/TranslationFile.html#add(java.lang.String,%20java.lang.String)">add</a></code>&nbsp;in
class&nbsp;<code><a
href="../../../com/intellectualsites/translation/TranslationFile.html"
title="class in com.intellectualsites.translation">TranslationFile</a></code>
</dd>
<dt><span class="strong">Parameters:</span></dt>
<dd><code>key</code> - translation name</dd>
<dd><code>value</code> - translation value</dd>
</dl>
</li>
</ul>
<a name="getLanguage()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLanguage</h4>
<pre>public&nbsp;<a
href="../../../com/intellectualsites/translation/TranslationLanguage.html"
title="class in com.intellectualsites.translation">TranslationLanguage</a>&nbsp;getLanguage()</pre>
<div class="block">Get the translation language</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a
href="../../../com/intellectualsites/translation/TranslationFile.html#getLanguage()">getLanguage</a></code>&nbsp;in
class&nbsp;<code><a
href="../../../com/intellectualsites/translation/TranslationFile.html"
title="class in com.intellectualsites.translation">TranslationFile</a></code>
</dd>
<dt><span class="strong">Returns:</span></dt>
<dd>language</dd>
</dl>
</li>
</ul>
<a name="saveFile()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>saveFile</h4>
<pre>public&nbsp;void&nbsp;saveFile()</pre>
<div class="block">Save the file</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a
href="../../../com/intellectualsites/translation/TranslationFile.html#saveFile()">saveFile</a></code>&nbsp;in
class&nbsp;<code><a
href="../../../com/intellectualsites/translation/TranslationFile.html"
title="class in com.intellectualsites.translation">TranslationFile</a></code>
</dd>
</dl>
</li>
</ul>
<a name="getYaml()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getYaml</h4>
<pre>public&nbsp;org.yaml.snakeyaml.Yaml&nbsp;getYaml()</pre>
<div class="block">Get the YAML object</div>
<dl>
<dt><span class="strong">Returns:</span></dt>
<dd>yaml object with correct settings</dd>
</dl>
</li>
</ul>
<a name="read()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>read</h4>
<pre>public&nbsp;<a
href="../../../com/intellectualsites/translation/YamlTranslationFile.html"
title="class in com.intellectualsites.translation">YamlTranslationFile</a>&nbsp;read()</pre>
<div class="block">Read the file</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a
href="../../../com/intellectualsites/translation/TranslationFile.html#read()">read</a></code>&nbsp;in
class&nbsp;<code><a
href="../../../com/intellectualsites/translation/TranslationFile.html"
title="class in com.intellectualsites.translation">TranslationFile</a></code>
</dd>
<dt><span class="strong">Returns:</span></dt>
<dd>instance</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../com/intellectualsites/translation/TranslationObject.html"
title="class in com.intellectualsites.translation"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/intellectualsites/translation/YamlTranslationFile.html" target="_top">Frames</a>
</li>
<li><a href="YamlTranslationFile.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All 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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&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>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
Reference in New Issue Copy Permalink