[Jiemamy-notify:1569] commit [2777] javadoc

Back to archive index

svnno****@sourc***** svnno****@sourc*****
2009年 3月 2日 (月) 11:01:04 JST


Revision: 2777
          http://svn.sourceforge.jp/view?root=jiemamy&view=rev&rev=2777
Author:   daisuke_m
Date:     2009-03-02 11:01:04 +0900 (Mon, 02 Mar 2009)

Log Message:
-----------
javadoc

Modified Paths:
--------------
    artemis/trunk/jiemamy-composer/src/main/java/org/jiemamy/composer/importer/DatabaseImportConfig.java
    artemis/trunk/jiemamy-composer/src/main/java/org/jiemamy/composer/importer/DefaultDatabaseImportConfig.java
    artemis/trunk/jiemamy-core/src/main/java/org/jiemamy/utils/LogMarker.java
    artemis/trunk/jiemamy-core/src/main/java/org/jiemamy/utils/ReflectionUtil.java
    artemis/trunk/jiemamy-core/src/main/java/org/jiemamy/utils/model/JiemamyPropertyUtil.java
    zeus/trunk/jiemamy-spec-core/src/main/java/org/jiemamy/JiemamyProperty.java


-------------- next part --------------
Modified: artemis/trunk/jiemamy-composer/src/main/java/org/jiemamy/composer/importer/DatabaseImportConfig.java
===================================================================
--- artemis/trunk/jiemamy-composer/src/main/java/org/jiemamy/composer/importer/DatabaseImportConfig.java	2009-03-02 01:56:03 UTC (rev 2776)
+++ artemis/trunk/jiemamy-composer/src/main/java/org/jiemamy/composer/importer/DatabaseImportConfig.java	2009-03-02 02:01:04 UTC (rev 2777)
@@ -31,72 +31,72 @@
 public interface DatabaseImportConfig extends ImportConfig {
 	
 	/**
-	 * TODO for daisuke
+	 * データベース名を取得する。
 	 * 
-	 * @return
+	 * @return データベース名
 	 */
 	String getDatabaseName();
 	
 	/**
-	 * TODO for daisuke
+	 * SQL方言を取得する。
 	 * 
-	 * @return
+	 * @return SQL方言
 	 */
 	Dialect getDialect();
 	
 	/**
-	 * TODO for daisuke
+	 * ドライバの完全修飾クラス名を取得する。
 	 * 
-	 * @return
+	 * @return ドライバの完全修飾クラス名
 	 */
 	String getDriverClassName();
 	
 	/**
-	 * TODO for daisuke
+	 * ドライバJARファイルのパス配列を取得する。
 	 * 
-	 * @return
+	 * @return ドライバJARファイルのパス配列
 	 */
 	URL[] getDriverJarPath();
 	
 	/**
-	 * TODO for daisuke
+	 * インポートするエンティティの種類
 	 * 
-	 * @return
+	 * @return インポートするエンティティの種類を取得する。
 	 */
 	String[] getEntityTypes();
 	
 	/**
-	 * TODO for daisuke
+	 * 接続パスワードを取得する。
 	 * 
-	 * @return
+	 * @return 接続パスワード
 	 */
 	String getPassword();
 	
 	/**
-	 * TODO for daisuke
+	 * スキーマ名を取得する。
 	 * 
-	 * @return
+	 * @return スキーマ名
 	 */
 	String getSchema();
 	
 	/**
-	 * TODO for daisuke
+	 * インポートするエンティティ名の配列を取得する。
 	 * 
-	 * @return
+	 * @return インポートするエンティティ名の配列
 	 */
 	String[] getSelectedEntities();
 	
 	/**
-	 * TODO for daisuke
+	 * 接続URIを取得する。
 	 * 
-	 * @return
+	 * @return 接続URI
 	 */
 	String getUri();
 	
 	/**
-	 * TODO for daisuke
+	 * 接続ユーザ名を取得する。
 	 * 
-	 * @return
+	 * @return 接続ユーザ名
 	 */
 	String getUsername();
 	

Modified: artemis/trunk/jiemamy-composer/src/main/java/org/jiemamy/composer/importer/DefaultDatabaseImportConfig.java
===================================================================
--- artemis/trunk/jiemamy-composer/src/main/java/org/jiemamy/composer/importer/DefaultDatabaseImportConfig.java	2009-03-02 01:56:03 UTC (rev 2776)
+++ artemis/trunk/jiemamy-composer/src/main/java/org/jiemamy/composer/importer/DefaultDatabaseImportConfig.java	2009-03-02 02:01:04 UTC (rev 2777)
@@ -32,7 +32,7 @@
 	/** SQL方言 */
 	private Dialect dialect;
 	
-	/** ドライバの完全就職クラス名 */
+	/** ドライバの完全修飾クラス名 */
 	private String driverClassName;
 	
 	/** ドライバJARファイルのパス配列 */

Modified: artemis/trunk/jiemamy-core/src/main/java/org/jiemamy/utils/LogMarker.java
===================================================================
--- artemis/trunk/jiemamy-core/src/main/java/org/jiemamy/utils/LogMarker.java	2009-03-02 01:56:03 UTC (rev 2776)
+++ artemis/trunk/jiemamy-core/src/main/java/org/jiemamy/utils/LogMarker.java	2009-03-02 02:01:04 UTC (rev 2777)
@@ -22,7 +22,7 @@
 import org.slf4j.MarkerFactory;
 
 /**
- * SLF4J用、ログマーカーを提供する定数クラス。
+ * SLF4Jのログマーカーを提供する定数クラス。
  * 
  * <p>cf. <a
  * href="http://d.hatena.ne.jp/taichitaichi/20090220/1235124140">http://d.hatena.ne.jp/taichitaichi/20090220/1235124140</a></p>
@@ -33,6 +33,7 @@
 	
 	private static final String PREFIX_PKG = "org.jiemamy";
 	
+	/** Jiemamy用 SLF4Jのルートログマーカー */
 	public static final Marker MARKER_ROOT = MarkerFactory.getMarker(PREFIX_PKG);
 	
 	/** 設計判断を伴う処理に関連する項目。アドインやプラグインに関連する部分など */

Modified: artemis/trunk/jiemamy-core/src/main/java/org/jiemamy/utils/ReflectionUtil.java
===================================================================
--- artemis/trunk/jiemamy-core/src/main/java/org/jiemamy/utils/ReflectionUtil.java	2009-03-02 01:56:03 UTC (rev 2776)
+++ artemis/trunk/jiemamy-core/src/main/java/org/jiemamy/utils/ReflectionUtil.java	2009-03-02 02:01:04 UTC (rev 2777)
@@ -60,21 +60,21 @@
 	}
 	
 	/**
-	 * TODO for daisuke
+	 * フィールド名からアクセサ名を割り出す。
 	 * 
-	 * @param fieldName
-	 * @param prefix
-	 * @return
+	 * @param fieldName フィールド名
+	 * @param prefix 接頭辞("set", "get", "is" 等)
+	 * @return アクセサ名
 	 */
 	public static String convertFieldNameToAccessorName(String fieldName, String prefix) {
 		return prefix + JmStringUtil.toCapital(fieldName);
 	}
 	
 	/**
-	 * TODO for daisuke
+	 * フィールド名からsetter名を割り出す。
 	 * 
-	 * @param fieldName
-	 * @return
+	 * @param fieldName フィールド名
+	 * @return setter名
 	 */
 	public static String convertFieldNameToSetterName(String fieldName) {
 		return convertFieldNameToAccessorName(fieldName, SET);

Modified: artemis/trunk/jiemamy-core/src/main/java/org/jiemamy/utils/model/JiemamyPropertyUtil.java
===================================================================
--- artemis/trunk/jiemamy-core/src/main/java/org/jiemamy/utils/model/JiemamyPropertyUtil.java	2009-03-02 01:56:03 UTC (rev 2776)
+++ artemis/trunk/jiemamy-core/src/main/java/org/jiemamy/utils/model/JiemamyPropertyUtil.java	2009-03-02 02:01:04 UTC (rev 2777)
@@ -21,28 +21,36 @@
 import java.lang.reflect.InvocationTargetException;
 import java.lang.reflect.Method;
 
+import org.apache.commons.lang.Validate;
+
 import org.jiemamy.JiemamyProperty;
 import org.jiemamy.exception.UnexpectedConditionError;
 import org.jiemamy.model.JiemamyElement;
 import org.jiemamy.utils.ReflectionUtil;
 
 /**
- * TODO for daisuke
+ * {@link JiemamyElement}のプロパティを扱うユーティリティクラス。
  * 
+ * @see JiemamyProperty
  * @author daisuke
  */
 public final class JiemamyPropertyUtil {
 	
 	/**
-	 * TODO for daisuke
+	 * {@link JiemamyElement}のプロパティの値を取得する。
 	 * 
-	 * @param element
-	 * @param property
-	 * @return
+	 * @param <T> {@link JiemamyElement}の型
+	 * @param element {@link JiemamyElement}インスタンス
+	 * @param property プロパティを示す値
+	 * @return プロパティの値
+	 * @throws IllegalArgumentException 引数に{@code null}を与えた場合
 	 */
 	public static <T extends JiemamyElement>Object getProperty(T element, JiemamyProperty<T> property) {
+		Validate.notNull(element);
+		Validate.notNull(property);
+		
 		String getterName = ReflectionUtil.convertFieldNameToAccessorName(property.name(), ReflectionUtil.GET);
-		Method method = null;
+		Method method;
 		try {
 			method = element.getClass().getMethod(getterName);
 		} catch (SecurityException e) {
@@ -57,7 +65,6 @@
 				throw new UnexpectedConditionError("アクセサの存在はテストで保証されているはず", e);
 			}
 		}
-		assert method != null;
 		
 		try {
 			return method.invoke(element);

Modified: zeus/trunk/jiemamy-spec-core/src/main/java/org/jiemamy/JiemamyProperty.java
===================================================================
--- zeus/trunk/jiemamy-spec-core/src/main/java/org/jiemamy/JiemamyProperty.java	2009-03-02 01:56:03 UTC (rev 2776)
+++ zeus/trunk/jiemamy-spec-core/src/main/java/org/jiemamy/JiemamyProperty.java	2009-03-02 02:01:04 UTC (rev 2777)
@@ -48,6 +48,12 @@
  */
 public interface JiemamyProperty<T extends JiemamyElement> {
 	
+	/**
+	 * プロパティ名を返す。
+	 * 
+	 * @return プロパティ名
+	 * @see Enum#name()
+	 */
 	String name();
 	
 



Jiemamy-notify メーリングリストの案内
Back to archive index