X-Git-Url: http://git.osdn.net/view?p=mikutoga%2FVmd2XML.git;a=blobdiff_plain;f=src%2Fmain%2Fjava%2Fjp%2Fsfjp%2Fmikutoga%2Fvmd2xml%2FVmd2XmlConv.java;fp=src%2Fmain%2Fjava%2Fjp%2Fsfjp%2Fmikutoga%2Fvmd2xml%2FVmd2XmlConv.java;h=5db580198c780dabf4bda4e89ad0a350e3c56a14;hp=2c0684cdd100e72ce1490bd3e497041c2e260b07;hb=05e547cf705e0e0e270ae9f92aa21fa56fec32dc;hpb=33403cac3d95399467317060af7ac875c6a1aaa5 diff --git a/src/main/java/jp/sfjp/mikutoga/vmd2xml/Vmd2XmlConv.java b/src/main/java/jp/sfjp/mikutoga/vmd2xml/Vmd2XmlConv.java index 2c0684c..5db5801 100644 --- a/src/main/java/jp/sfjp/mikutoga/vmd2xml/Vmd2XmlConv.java +++ b/src/main/java/jp/sfjp/mikutoga/vmd2xml/Vmd2XmlConv.java @@ -54,6 +54,7 @@ public class Vmd2XmlConv { /** * 入力ファイル種別を設定する。 + * * @param type ファイル種別 * @throws IllegalArgumentException 具体的な種別を渡さなかった */ @@ -67,6 +68,7 @@ public class Vmd2XmlConv { /** * 入力ファイル種別を返す。 + * * @return ファイル種別 */ public MotionFileType getInTypes(){ @@ -75,6 +77,7 @@ public class Vmd2XmlConv { /** * 出力ファイル種別を設定する。 + * * @param type ファイル種別 * @throws IllegalArgumentException 具体的な種別を渡さなかった */ @@ -88,6 +91,7 @@ public class Vmd2XmlConv { /** * 出力ファイル種別を返す。 + * * @return ファイル種別 */ public MotionFileType getOutTypes(){ @@ -96,6 +100,7 @@ public class Vmd2XmlConv { /** * XML出力用改行文字列を設定する。 + * * @param newline 改行文字 */ public void setNewline(String newline){ @@ -105,6 +110,7 @@ public class Vmd2XmlConv { /** * XML出力用改行文字列を返す。 + * * @return 改行文字 */ public String getNewline(){ @@ -113,6 +119,7 @@ public class Vmd2XmlConv { /** * ジェネレータ名を設定する。 + * * @param generator ジェネレータ名。表示したくない場合はnull */ public void setGenerator(String generator){ @@ -122,6 +129,7 @@ public class Vmd2XmlConv { /** * ジェネレータ名を返す。 + * * @return ジェネレータ名。非表示の場合はnullを返す。 */ public String getGenerator(){ @@ -130,8 +138,9 @@ public class Vmd2XmlConv { /** * 回転情報をクォータニオン形式でXML出力するか設定する。 + * * @param sw クォータニオン形式ならtrue、 - * YXZオイラー角で出力したければfalse。 + * YXZオイラー角で出力したければfalse。 */ public void setQuaterniomMode(boolean sw){ this.isQuaternionMode = sw; @@ -140,6 +149,7 @@ public class Vmd2XmlConv { /** * 回転情報のXML出力形式を得る。 + * * @return クォータニオン形式ならtrue、YXZオイラー角形式ならfalse。 */ public boolean isQuaterniomMode(){ @@ -148,8 +158,10 @@ public class Vmd2XmlConv { /** * ファイル変換を行う。 + * *

XML入力の場合は{@link #convert(InputSource, OutputStream)}を * 推奨する。 + * * @param is 入力ストリーム * @param os 出力ストリーム * @throws IOException 入力エラー @@ -172,10 +184,13 @@ public class Vmd2XmlConv { /** * ファイル変換を行う。 + * *

VMD入力の場合は{@link InputStream}に * バイトストリームが直接設定されていなければならない。 + * *

XML入力の場合は{@link InputStream}に * URL(systemId)のみの設定を推奨する。 + * * @param source 入力ソース * @param os 出力ストリーム * @throws IOException 入力エラー @@ -198,8 +213,10 @@ public class Vmd2XmlConv { /** * モーションファイルを読み込む。 + * *

XML読み込みの場合は、 * こちらより{@link #readMotion(InputSource)}版を推奨する。 + * * @param is 入力ストリーム * @return モーションデータ * @throws IOException 入力エラー @@ -226,8 +243,10 @@ public class Vmd2XmlConv { /** * モーションファイルを読み込む。 + * *

VMD入力の場合は、{@link InputStream}に * 納められたバイトストリームかSystemId-URLから読み込む。 + * * @param source 入力ソース * @return モーションデータ * @throws IOException 入力エラー @@ -260,6 +279,7 @@ public class Vmd2XmlConv { /** * モーションファイルを出力する。 + * * @param motion モーションデータ * @param os 出力ストリーム * @throws IOException 出力エラー @@ -281,7 +301,9 @@ public class Vmd2XmlConv { /** * VMDファイルからモーションデータを読み込む。 + * *

入力ストリームは最後に閉じられる。 + * * @param is 入力ストリーム * @return モーションデータ * @throws IOException 入力エラー @@ -300,6 +322,7 @@ public class Vmd2XmlConv { /** * XMLファイルからモーションデータを読み込む。 + * * @param source 入力ソース * @return モーションデータ * @throws IOException 入力エラー @@ -320,6 +343,7 @@ public class Vmd2XmlConv { /** * モーションデータをVMDファイルに出力する。 + * * @param motion モーションデータ * @param ostream 出力ストリーム * @throws IOException 出力エラー @@ -335,6 +359,7 @@ public class Vmd2XmlConv { /** * モーションデータをXMLファイルに出力する。 + * * @param motion モーションデータ * @param ostream 出力ストリーム * @throws IOException 出力エラー