diff options
author | Stef <stef@ws.local> | 2004-05-05 22:25:55 +0000 |
---|---|---|
committer | Stef <stef@ws.local> | 2004-05-05 22:25:55 +0000 |
commit | 9e78a8d490ee05f131f9700cead9c7f75eba3a3b (patch) | |
tree | db588b5b7d081e2e44ced99e6275c2a25f18c580 /src/com/memberwebs/ldapxml/LXHook.java | |
parent | 6db9fa640c99591ea5be2dc90bd95f2ef6d9ffde (diff) |
Documentation fixes
Diffstat (limited to 'src/com/memberwebs/ldapxml/LXHook.java')
-rw-r--r-- | src/com/memberwebs/ldapxml/LXHook.java | 23 |
1 files changed, 18 insertions, 5 deletions
diff --git a/src/com/memberwebs/ldapxml/LXHook.java b/src/com/memberwebs/ldapxml/LXHook.java index 6b12e08..7efc6ec 100644 --- a/src/com/memberwebs/ldapxml/LXHook.java +++ b/src/com/memberwebs/ldapxml/LXHook.java @@ -51,18 +51,28 @@ import com.novell.ldap.LDAPEntry; public interface LXHook { /** - * Initialize this hook. + * Initialize this hook. The parameter is passed through to + * this object by creating an LXSpecs object, using + * LXSpecs.setData to set custom data and then one of the + * LXReader methods that allow passing in of a LXSpecs object. * - * @param obj An initialization parameter passed into LXSpecs.setData + * The custom data will then be passed to this method the + * first time that this hook is used. + * + * @param obj An initialization parameter */ public void initialize(Object obj) throws LXException; /** - * Allows pre processing of an entry retrieved from LDAP + * Allows pre processing of an entry retrieved from LDAP. + * + * By modifying the passed LDAPEntry object, you can affect the + * way the map handles your data. Returning false, will cause + * this entry to be ignored as if it didn't exist. * * @param entry The LDAP entry retrieved - * @return If false then this element will not be included in tree. + * @return If false then this element will not be included. */ public boolean prefix(LDAPEntry entry) throws LXException; @@ -70,9 +80,12 @@ public interface LXHook /** * Allows post processing of an element retrieved from LDAP. * + * You can modify the final constructed XML element at this + * point. By returning false you cause this element to be discarded. + * * @param entry The LDAP entry retrieved. * @param el The DOM element constructed. - * @return If false then this element will not be included in tree. + * @return If false then this element. */ public boolean postfix(LDAPEntry entry, Element el) throws LXException; |