Menu
▾
▴
[tmapi-commit] SF.net SVN: tmapi:[84] trunk/src/main/java/org/tmapi/core
|
From: <lh...@us...> - 2008-11-01 16:38:44
|
Revision: 84
http://tmapi.svn.sourceforge.net/tmapi/?rev=84&view=rev
Author: lheuer
Date: 2008-11-01 16:38:35 +0000 (Sat, 01 Nov 2008)
Log Message:
-----------
Changed parameter naming:
iid -> itemIdentifier
sid -> subjectIdentifier
slo -> subjectLocator
(suggested by Marcel Hoyer)
Modified Paths:
--------------
trunk/src/main/java/org/tmapi/core/Construct.java
trunk/src/main/java/org/tmapi/core/Topic.java
trunk/src/main/java/org/tmapi/core/TopicMap.java
Modified: trunk/src/main/java/org/tmapi/core/Construct.java
===================================================================
--- trunk/src/main/java/org/tmapi/core/Construct.java 2008-11-01 16:33:16 UTC (rev 83)
+++ trunk/src/main/java/org/tmapi/core/Construct.java 2008-11-01 16:38:35 UTC (rev 84)
@@ -73,18 +73,18 @@
* If at least one of the two objects is not a {@link Topic}, an
* {@link IdentityConstraintException} must be reported.
*
- * @param iid The item identifier to be added; must not be <tt>null</tt>.
+ * @param itemIdentifier The item identifier to be added; must not be <tt>null</tt>.
* @throws IdentityConstraintException If another construct has an item
- * identifier which is equal to <tt>iid</tt>.
+ * identifier which is equal to <tt>itemIdentifier</tt>.
*/
- public void addItemIdentifier(Locator iid);
+ public void addItemIdentifier(Locator itemIdentifier);
/**
* Removes an item identifier.
*
- * @param iid The item identifier to be removed.
+ * @param itemIdentifier The item identifier to be removed.
*/
- public void removeItemIdentifier(Locator iid);
+ public void removeItemIdentifier(Locator itemIdentifier);
/**
* Deletes this construct from its parent container.
Modified: trunk/src/main/java/org/tmapi/core/Topic.java
===================================================================
--- trunk/src/main/java/org/tmapi/core/Topic.java 2008-11-01 16:33:16 UTC (rev 83)
+++ trunk/src/main/java/org/tmapi/core/Topic.java 2008-11-01 16:38:35 UTC (rev 84)
@@ -45,7 +45,7 @@
*
* @see org.tmapi.core.Construct#addItemIdentifier(org.tmapi.core.Locator)
*/
- public void addItemIdentifier(Locator iid);
+ public void addItemIdentifier(Locator itemIdentifier);
/**
* Returns the subject identifiers assigned to this topic.
@@ -66,19 +66,19 @@
* an {@link IdentityConstraintException} is thrown.
* </p>
*
- * @param sid The subject identifier to be added; must not be <tt>null</tt>.
+ * @param subjectIdentifier The subject identifier to be added; must not be <tt>null</tt>.
* @throws IdentityConstraintException If the feature "automerge" is
* disabled and adding the subject identifier would make this
* topic represent the same subject as another topic.
*/
- public void addSubjectIdentifier(Locator sid);
+ public void addSubjectIdentifier(Locator subjectIdentifier);
/**
* Removes a subject identifier from this topic.
*
- * @param sid The subject identifier to be removed.
+ * @param subjectIdentifier The subject identifier to be removed.
*/
- public void removeSubjectIdentifier(Locator sid);
+ public void removeSubjectIdentifier(Locator subjectIdentifier);
/**
* Returns the subject locators assigned to this topic.
@@ -99,19 +99,19 @@
* an {@link IdentityConstraintException} is thrown.
* </p>
*
- * @param slo The subject locator to be added; must not be <tt>null</tt>.
+ * @param subjectLocator The subject locator to be added; must not be <tt>null</tt>.
* @throws IdentityConstraintException If the feature "automerge" is
* disabled and adding the subject locator would make this
* topic represent the same subject as another topic.
*/
- public void addSubjectLocator(Locator slo);
+ public void addSubjectLocator(Locator subjectLocator);
/**
* Removes a subject locator from this topic.
*
- * @param slo The subject locator to be removed.
+ * @param subjectLocator The subject locator to be removed.
*/
- public void removeSubjectLocator(Locator slo);
+ public void removeSubjectLocator(Locator subjectLocator);
/**
* Returns the names of this topic.
Modified: trunk/src/main/java/org/tmapi/core/TopicMap.java
===================================================================
--- trunk/src/main/java/org/tmapi/core/TopicMap.java 2008-11-01 16:33:16 UTC (rev 83)
+++ trunk/src/main/java/org/tmapi/core/TopicMap.java 2008-11-01 16:38:35 UTC (rev 84)
@@ -59,11 +59,11 @@
* returns <tt>null</tt>.
* </p>
*
- * @param sid The subject identifier of the topic to be returned.
+ * @param subjectIdentifier The subject identifier of the topic to be returned.
* @return A topic with the specified subject identifier or <tt>null</tt>
* if no such topic exists in the topic map.
*/
- public Topic getTopicBySubjectIdentifier(Locator sid);
+ public Topic getTopicBySubjectIdentifier(Locator subjectIdentifier);
/**
* Returns a topic by its subject locator.
@@ -72,20 +72,20 @@
* returns <tt>null</tt>.
* </p>
*
- * @param slo The subject locator of the topic to be returned.
+ * @param subjectLocator The subject locator of the topic to be returned.
* @return A topic with the specified subject locator or <tt>null</tt>
* if no such topic exists in the topic map.
*/
- public Topic getTopicBySubjectLocator(Locator slo);
+ public Topic getTopicBySubjectLocator(Locator subjectLocator);
/**
* Returns a {@link Construct} by its item identifier.
*
- * @param iid The item identifier of the construct to be returned.
+ * @param itemIdentifier The item identifier of the construct to be returned.
* @return A construct with the specified item identifier or <tt>null</tt>
* if no such construct exists in the topic map.
*/
- public Construct getConstructByItemIdentifier(Locator iid);
+ public Construct getConstructByItemIdentifier(Locator itemIdentifier);
/**
* Returns a {@link Construct} by its (system specific) identifier.
@@ -123,11 +123,11 @@
* the subject identifier is created.
* </p>
*
- * @param sid The subject identifier the topic should contain.
+ * @param subjectIdentifier The subject identifier the topic should contain.
* @return A {@link Topic} instance with the specified subject identifier.
- * @throws ModelConstraintException If the subject identifier <tt>sid</tt> is <tt>null</tt>.
+ * @throws ModelConstraintException If the subject identifier <tt>subjectIdentifier</tt> is <tt>null</tt>.
*/
- public Topic createTopicBySubjectIdentifier(Locator sid);
+ public Topic createTopicBySubjectIdentifier(Locator subjectIdentifier);
/**
* Returns a {@link Topic} instance with the specified subject locator.
@@ -136,11 +136,11 @@
* {@link Topic} instance with the specified subject locator.
* </p>
*
- * @param slo The subject locator the topic should contain.
+ * @param subjectLocator The subject locator the topic should contain.
* @return A {@link Topic} instance with the specified subject locator.
- * @throws ModelConstraintException If the subject locator <tt>slo</tt> is <tt>null</tt>.
+ * @throws ModelConstraintException If the subject locator <tt>subjectLocator</tt> is <tt>null</tt>.
*/
- public Topic createTopicBySubjectLocator(Locator slo);
+ public Topic createTopicBySubjectLocator(Locator subjectLocator);
/**
* Returns a {@link Topic} instance with the specified item identifier.
@@ -158,13 +158,13 @@
* the item identifier is created.
* </p>
*
- * @param iid The item identifier the topic should contain.
+ * @param itemIdentifier The item identifier the topic should contain.
* @return A {@link Topic} instance with the specified item identifier.
- * @throws ModelConstraintException If the item identifier <tt>iid</tt> is <tt>null</tt>.
+ * @throws ModelConstraintException If the item identifier <tt>itemIdentifier</tt> is <tt>null</tt>.
* @throws IdentityConstraintException If an other {@link Construct} with the
* specified item identifier exists which is not a {@link Topic}.
*/
- public Topic createTopicByItemIdentifier(Locator iid);
+ public Topic createTopicByItemIdentifier(Locator itemIdentifier);
/**
* Returns a {@link Topic} instance with an automatically generated item
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
