Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorslewis2007-10-26 02:39:31 +0000
committerslewis2007-10-26 02:39:31 +0000
commit58e1e009baefe077a10bb0594ce7e3cd8e17b9a7 (patch)
tree7bdf927f24a405edf3396a95c04f58ae39facdc0 /incubation/bundles
parentf5b6ae4c1fa23aa4efcdda69aa41a9d2fd534644 (diff)
downloadorg.eclipse.ecf-58e1e009baefe077a10bb0594ce7e3cd8e17b9a7.tar.gz
org.eclipse.ecf-58e1e009baefe077a10bb0594ce7e3cd8e17b9a7.tar.xz
org.eclipse.ecf-58e1e009baefe077a10bb0594ce7e3cd8e17b9a7.zip
Fixed errors in javadocs
Diffstat (limited to 'incubation/bundles')
-rw-r--r--incubation/bundles/org.eclipse.ecf.bulletinboard.commons/src/org/eclipse/ecf/internal/bulletinboard/commons/AbstractBulletinBoard.java40
-rw-r--r--incubation/bundles/org.eclipse.ecf.bulletinboard.commons/src/org/eclipse/ecf/internal/bulletinboard/commons/IBBObjectFactory.java9
2 files changed, 25 insertions, 24 deletions
diff --git a/incubation/bundles/org.eclipse.ecf.bulletinboard.commons/src/org/eclipse/ecf/internal/bulletinboard/commons/AbstractBulletinBoard.java b/incubation/bundles/org.eclipse.ecf.bulletinboard.commons/src/org/eclipse/ecf/internal/bulletinboard/commons/AbstractBulletinBoard.java
index d19d3f036..7c3793def 100644
--- a/incubation/bundles/org.eclipse.ecf.bulletinboard.commons/src/org/eclipse/ecf/internal/bulletinboard/commons/AbstractBulletinBoard.java
+++ b/incubation/bundles/org.eclipse.ecf.bulletinboard.commons/src/org/eclipse/ecf/internal/bulletinboard/commons/AbstractBulletinBoard.java
@@ -21,10 +21,9 @@ import org.eclipse.ecf.core.identity.ID;
import org.eclipse.ecf.core.identity.Namespace;
import org.eclipse.ecf.internal.bulletinboard.commons.webapp.WebRequest;
-public abstract class AbstractBulletinBoard implements
- IBulletinBoardContainerAdapter {
+public abstract class AbstractBulletinBoard implements IBulletinBoardContainerAdapter {
- private AbstractBBContainer mainContainer;
+ private final AbstractBBContainer mainContainer;
protected AbstractParser parser;
@@ -56,9 +55,9 @@ public abstract class AbstractBulletinBoard implements
public void postConnect() {
try {
this.url = new URL(getID().toExternalForm());
- MultiThreadedHttpConnectionManager connectionManager = new MultiThreadedHttpConnectionManager();
+ final MultiThreadedHttpConnectionManager connectionManager = new MultiThreadedHttpConnectionManager();
httpClient = new HttpClient(connectionManager);
- } catch (MalformedURLException e) {
+ } catch (final MalformedURLException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
@@ -70,6 +69,7 @@ public abstract class AbstractBulletinBoard implements
}
/**
+ * @return <code>true</code> if connected, <code>false</code> otherwise.
* @deprecated Connection status should be the business of the main
* container.
*/
@@ -78,6 +78,7 @@ public abstract class AbstractBulletinBoard implements
}
/**
+ * @throws BBException
* @deprecated Connection status should be the business of the main
* container.
*/
@@ -94,8 +95,9 @@ public abstract class AbstractBulletinBoard implements
}
public Object getAdapter(Class adapter) {
- IAdapterManager adapterManager = Activator.getDefault().getAdapterManager();
- if (adapterManager == null) return null;
+ final IAdapterManager adapterManager = Activator.getDefault().getAdapterManager();
+ if (adapterManager == null)
+ return null;
return adapterManager.getAdapter(this, adapter);
}
@@ -121,19 +123,19 @@ public abstract class AbstractBulletinBoard implements
if (cachedMembers.containsKey(id)) {
return cachedMembers.get(id);
} else {
- WebRequest request = createMemberPageRequest(id);
+ final WebRequest request = createMemberPageRequest(id);
try {
request.execute();
- String str = request.getResponseBodyAsString();
+ final String str = request.getResponseBodyAsString();
request.releaseConnection();
- IMember member = parser.parseMemberPageForName(str, id);
+ final IMember member = parser.parseMemberPageForName(str, id);
if (member != null) {
((AbstractBBObject) member).setBulletinBoard(this);
cachedMembers.put(member.getID(), member);
return member;
}
- } catch (Exception e) {
+ } catch (final Exception e) {
e.printStackTrace();
}
return null;
@@ -152,16 +154,16 @@ public abstract class AbstractBulletinBoard implements
public List<IMember> getMembers() throws BBException {
// TODO: this only returns first page
if (cachedMembers.isEmpty()) {
- WebRequest request = createMemberListRequest();
+ final WebRequest request = createMemberListRequest();
try {
request.execute();
- String str = request.getResponseBodyAsString();
+ final String str = request.getResponseBodyAsString();
request.releaseConnection();
cachedMembers = parser.parseMembers(str);
- for (IMember member : cachedMembers.values()) {
+ for (final IMember member : cachedMembers.values()) {
((AbstractBBObject) member).setBulletinBoard(this);
}
- } catch (IOException e) {
+ } catch (final IOException e) {
e.printStackTrace();
}
}
@@ -172,16 +174,16 @@ public abstract class AbstractBulletinBoard implements
public Collection<IMemberGroup> getMemberGroups() throws BBException {
if (cachedMemberGroups.isEmpty()) {
- WebRequest request = createMemberGroupListRequest();
+ final WebRequest request = createMemberGroupListRequest();
try {
request.execute();
- String str = request.getResponseBodyAsString();
+ final String str = request.getResponseBodyAsString();
request.releaseConnection();
cachedMemberGroups = parser.parseMemberGroups(str);
- for (IMemberGroup grp : cachedMemberGroups.values()) {
+ for (final IMemberGroup grp : cachedMemberGroups.values()) {
((AbstractBBObject) grp).setBulletinBoard(this);
}
- } catch (IOException e) {
+ } catch (final IOException e) {
// log.error(e);
}
}
diff --git a/incubation/bundles/org.eclipse.ecf.bulletinboard.commons/src/org/eclipse/ecf/internal/bulletinboard/commons/IBBObjectFactory.java b/incubation/bundles/org.eclipse.ecf.bulletinboard.commons/src/org/eclipse/ecf/internal/bulletinboard/commons/IBBObjectFactory.java
index 696c6292e..60ef844e0 100644
--- a/incubation/bundles/org.eclipse.ecf.bulletinboard.commons/src/org/eclipse/ecf/internal/bulletinboard/commons/IBBObjectFactory.java
+++ b/incubation/bundles/org.eclipse.ecf.bulletinboard.commons/src/org/eclipse/ecf/internal/bulletinboard/commons/IBBObjectFactory.java
@@ -35,13 +35,11 @@ public interface IBBObjectFactory {
* @param stringValue
* the value that the id is to be created from
* @return the created IBBObjectId implementation
- * @throws IDInstantiationException
+ * @throws IDCreateException
*/
- public ID createBBObjectId(Namespace namespace, String stringValue)
- throws IDCreateException;
+ public ID createBBObjectId(Namespace namespace, String stringValue) throws IDCreateException;
- public ID createBBObjectId(Namespace namespace, URL baseURL,
- String stringValue) throws IDCreateException;
+ public ID createBBObjectId(Namespace namespace, URL baseURL, String stringValue) throws IDCreateException;
/**
* Creates a named and identified IBBObject implementation.
@@ -50,6 +48,7 @@ public interface IBBObjectFactory {
* the object's identifier
* @param name
* the object's name
+ * @param parameters any parameters
* @return the created IBBObject implementation
*/
public IBBObject createBBObject(ID id, String name, Map<String, Object> parameters);

Back to the top