Author: norman
Date: Fri Jun 1 09:07:06 2007
New Revision: 543521
URL: http://svn.apache.org/viewvc?view=rev&rev=543521
Log:
Only some small javadocs corrections
Modified:
james/jspf/trunk/src/main/java/org/apache/james/jspf/FutureSPFResult.java
james/jspf/trunk/src/main/java/org/apache/james/jspf/SPFResult.java
james/jspf/trunk/src/main/java/org/apache/james/jspf/core/Directive.java
james/jspf/trunk/src/main/java/org/apache/james/jspf/core/IResponseImpl.java
james/jspf/trunk/src/main/java/org/apache/james/jspf/core/SPF1Record.java
james/jspf/trunk/src/main/java/org/apache/james/jspf/parser/MatcherBasedConfiguration.java
Modified:
james/jspf/trunk/src/main/java/org/apache/james/jspf/FutureSPFResult.java
URL:
http://svn.apache.org/viewvc/james/jspf/trunk/src/main/java/org/apache/james/jspf/FutureSPFResult.java?view=diff&rev=543521&r1=543520&r2=543521
==============================================================================
--- james/jspf/trunk/src/main/java/org/apache/james/jspf/FutureSPFResult.java
(original)
+++ james/jspf/trunk/src/main/java/org/apache/james/jspf/FutureSPFResult.java
Fri Jun 1 09:07:06 2007
@@ -21,6 +21,10 @@
import org.apache.james.jspf.core.SPFSession;
+/**
+ * A Blocking version of SPFResult which block until the SPFResult is fully set
+ *
+ */
public class FutureSPFResult extends SPFResult {
boolean isReady;
@@ -41,6 +45,10 @@
notify();
}
+ /**
+ * Waits until the SPFResult is set
+ *
+ */
private synchronized void checkReady() {
while (!isReady) {
try {
@@ -99,6 +107,4 @@
public boolean isReady() {
return isReady;
}
-
-
}
Modified: james/jspf/trunk/src/main/java/org/apache/james/jspf/SPFResult.java
URL:
http://svn.apache.org/viewvc/james/jspf/trunk/src/main/java/org/apache/james/jspf/SPFResult.java?view=diff&rev=543521&r1=543520&r2=543521
==============================================================================
--- james/jspf/trunk/src/main/java/org/apache/james/jspf/SPFResult.java
(original)
+++ james/jspf/trunk/src/main/java/org/apache/james/jspf/SPFResult.java Fri Jun
1 09:07:06 2007
@@ -46,20 +46,21 @@
*
* @param result the result
* @param explanation the explanation
- * @param spf1data the SPF1Data
+ * @param spfSession the SPFSession
*/
- public SPFResult(SPFSession spf1data) {
- setSPFSession(spf1data);
+ public SPFResult(SPFSession spfSession) {
+ setSPFSession(spfSession);
}
/**
* Initialize the result.
- * @param spf1data
+ *
+ * @param spfSession
*/
- protected void setSPFSession(SPFSession spf1data) {
- this.explanation = spf1data.getExplanation();
- this.result = spf1data.getCurrentResultExpanded();
- this.headerTextAsString = generateHeader(result, spf1data);
+ protected void setSPFSession(SPFSession spfSession) {
+ this.explanation = spfSession.getExplanation();
+ this.result = spfSession.getCurrentResultExpanded();
+ this.headerTextAsString = generateHeader(result, spfSession);
}
/**
Modified:
james/jspf/trunk/src/main/java/org/apache/james/jspf/core/Directive.java
URL:
http://svn.apache.org/viewvc/james/jspf/trunk/src/main/java/org/apache/james/jspf/core/Directive.java?view=diff&rev=543521&r1=543520&r2=543521
==============================================================================
--- james/jspf/trunk/src/main/java/org/apache/james/jspf/core/Directive.java
(original)
+++ james/jspf/trunk/src/main/java/org/apache/james/jspf/core/Directive.java
Fri Jun 1 09:07:06 2007
@@ -32,6 +32,9 @@
private final class MechanismResultChecker implements SPFChecker {
+ /**
+ * @see
org.apache.james.jspf.core.SPFChecker#checkSPF(org.apache.james.jspf.core.SPFSession)
+ */
public DNSLookupContinuation checkSPF(SPFSession spfData)
throws PermErrorException, TempErrorException,
NeutralException, NoneException {
@@ -87,23 +90,23 @@
/**
* Run the Directive
*
- * @param spfData The SPF1Data to use
+ * @param spfSession The SPFSession to use
* @return The qualifier which was returned
* @throws PermErrorException get thrown if a PermError should returned
* @throws TempErrorException get thrown if a TempError should returned
* @throws NoneException get thrown if a NoneException should returned;
* @throws NeutralException
*/
- public DNSLookupContinuation checkSPF(SPFSession spfData) throws
PermErrorException,
+ public DNSLookupContinuation checkSPF(SPFSession spfSession) throws
PermErrorException,
TempErrorException, NoneException, NeutralException {
// if already have a current result we don't run this
- if (spfData.getCurrentResult() == null) {
+ if (spfSession.getCurrentResult() == null) {
- spfData.removeAttribute(ATTRIBUTE_MECHANISM_RESULT);
+ spfSession.removeAttribute(ATTRIBUTE_MECHANISM_RESULT);
- spfData.pushChecker(resultChecker);
+ spfSession.pushChecker(resultChecker);
- spfData.pushChecker(mechanism);
+ spfSession.pushChecker(mechanism);
}
return null;
@@ -131,10 +134,14 @@
return qualifier + mechanism;
}
+ /*
+ * TODO: Can we remove this ?
+ *
public void onDNSResponse(DNSResponse response, SPFSession spfSession)
throws PermErrorException, NoneException, TempErrorException,
NeutralException {
throw new IllegalStateException("NOT USED YET");
}
+ */
}
Modified:
james/jspf/trunk/src/main/java/org/apache/james/jspf/core/IResponseImpl.java
URL:
http://svn.apache.org/viewvc/james/jspf/trunk/src/main/java/org/apache/james/jspf/core/IResponseImpl.java?view=diff&rev=543521&r1=543520&r2=543521
==============================================================================
---
james/jspf/trunk/src/main/java/org/apache/james/jspf/core/IResponseImpl.java
(original)
+++
james/jspf/trunk/src/main/java/org/apache/james/jspf/core/IResponseImpl.java
Fri Jun 1 09:07:06 2007
@@ -22,6 +22,10 @@
import java.util.List;
+/**
+ * Implementation of an IRespone Object
+ *
+ */
public class IResponseImpl implements IResponse {
private Exception exception = null;
private List value = null;
Modified:
james/jspf/trunk/src/main/java/org/apache/james/jspf/core/SPF1Record.java
URL:
http://svn.apache.org/viewvc/james/jspf/trunk/src/main/java/org/apache/james/jspf/core/SPF1Record.java?view=diff&rev=543521&r1=543520&r2=543521
==============================================================================
--- james/jspf/trunk/src/main/java/org/apache/james/jspf/core/SPF1Record.java
(original)
+++ james/jspf/trunk/src/main/java/org/apache/james/jspf/core/SPF1Record.java
Fri Jun 1 09:07:06 2007
@@ -81,6 +81,9 @@
boolean first = true;
Iterator current = getDirectives().iterator();
+ /**
+ * @see java.util.Iterator#hasNext()
+ */
public boolean hasNext() {
if (current.hasNext()) {
return true;
@@ -91,10 +94,16 @@
} else return false;
}
+ /**
+ * @see java.util.Iterator#next()
+ */
public Object next() {
return current.next();
}
+ /**
+ * @see java.util.Iterator#remove()
+ */
public void remove() {
throw new UnsupportedOperationException("Readonly iterator");
}
Modified:
james/jspf/trunk/src/main/java/org/apache/james/jspf/parser/MatcherBasedConfiguration.java
URL:
http://svn.apache.org/viewvc/james/jspf/trunk/src/main/java/org/apache/james/jspf/parser/MatcherBasedConfiguration.java?view=diff&rev=543521&r1=543520&r2=543521
==============================================================================
---
james/jspf/trunk/src/main/java/org/apache/james/jspf/parser/MatcherBasedConfiguration.java
(original)
+++
james/jspf/trunk/src/main/java/org/apache/james/jspf/parser/MatcherBasedConfiguration.java
Fri Jun 1 09:07:06 2007
@@ -51,14 +51,14 @@
this.start = start;
}
- /* (non-Javadoc)
+ /**
* @see org.apache.james.jspf.core.Configuration#group(int)
*/
public String group(int arg0) {
return wrapped.group(arg0 + start);
}
- /* (non-Javadoc)
+ /**
* @see org.apache.james.jspf.core.Configuration#groupCount()
*/
public int groupCount() {
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
