From a7465c1475e2089915c283bd3efd6fc63ad5c1bf Mon Sep 17 00:00:00 2001 From: Keith Donald Date: Fri, 24 Jul 2009 19:40:11 +0000 Subject: [PATCH] javadoc polish --- .../ui/binding/config/Condition.java | 18 ++++++++++++++++++ .../config/FieldModelConfiguration.java | 4 +++- .../support/DefaultPresentationModel.java | 10 +++++----- .../ui/binding/support/package.html | 2 +- 4 files changed, 27 insertions(+), 7 deletions(-) diff --git a/org.springframework.context/src/main/java/org/springframework/ui/binding/config/Condition.java b/org.springframework.context/src/main/java/org/springframework/ui/binding/config/Condition.java index 2d800fc1a2b..afd205748f0 100644 --- a/org.springframework.context/src/main/java/org/springframework/ui/binding/config/Condition.java +++ b/org.springframework.context/src/main/java/org/springframework/ui/binding/config/Condition.java @@ -15,16 +15,34 @@ */ package org.springframework.ui.binding.config; +import org.springframework.ui.binding.FieldModel; + +/** + * A FieldModel condition. + * @author Keith Donald + * @see FieldModel#isEnabled() + * @see FieldModel#isEditable() + * @see FieldModel#isVisible() + */ public interface Condition { + /** + * Is the condition true or false? + */ boolean isTrue(); + /** + * The condition is always true. + */ static final Condition ALWAYS_TRUE = new Condition() { public boolean isTrue() { return true; } }; + /** + * The condition is always false. + */ static final Condition ALWAYS_FALSE = new Condition() { public boolean isTrue() { return false; diff --git a/org.springframework.context/src/main/java/org/springframework/ui/binding/config/FieldModelConfiguration.java b/org.springframework.context/src/main/java/org/springframework/ui/binding/config/FieldModelConfiguration.java index cf6f23ea666..f37360bd9ca 100644 --- a/org.springframework.context/src/main/java/org/springframework/ui/binding/config/FieldModelConfiguration.java +++ b/org.springframework.context/src/main/java/org/springframework/ui/binding/config/FieldModelConfiguration.java @@ -15,11 +15,13 @@ */ package org.springframework.ui.binding.config; +import org.springframework.ui.binding.FieldModel; import org.springframework.ui.format.Formatter; /** - * A fluent interface for configuring a newly added field model. + * A fluent interface for configuring a {@link FieldModel}. * @author Keith Donald + * @since 3.0 */ public interface FieldModelConfiguration { diff --git a/org.springframework.context/src/main/java/org/springframework/ui/binding/support/DefaultPresentationModel.java b/org.springframework.context/src/main/java/org/springframework/ui/binding/support/DefaultPresentationModel.java index b2dea844896..2e9ad0f0e45 100644 --- a/org.springframework.context/src/main/java/org/springframework/ui/binding/support/DefaultPresentationModel.java +++ b/org.springframework.context/src/main/java/org/springframework/ui/binding/support/DefaultPresentationModel.java @@ -102,12 +102,12 @@ public class DefaultPresentationModel implements PresentationModel { } /** - * Add a FieldModel rule at the domain object property path. - * @param propertyPath the domain object property path in format <prop>[.nestedProp] - * @return a builder for the field model configuration + * Add a FieldModel configuration at the path specified. + * @param fieldPath the domain object property path in format <prop>[.nestedProp] + * @return a builder for the {@link FieldModel} configuration */ - public FieldModelConfiguration field(String propertyPath) { - FieldPath path = new FieldPath(propertyPath); + public FieldModelConfiguration field(String fieldPath) { + FieldPath path = new FieldPath(fieldPath); PropertyFieldModelRule rule = getRule(path.getFirstElement().getValue()); for (FieldPathElement element : path.getNestedElements()) { rule = rule.getNestedRule(element.getValue()); diff --git a/org.springframework.context/src/main/java/org/springframework/ui/binding/support/package.html b/org.springframework.context/src/main/java/org/springframework/ui/binding/support/package.html index 862e579c0c5..dc652e43016 100644 --- a/org.springframework.context/src/main/java/org/springframework/ui/binding/support/package.html +++ b/org.springframework.context/src/main/java/org/springframework/ui/binding/support/package.html @@ -1,7 +1,7 @@

-Default implementation of a PresentationModel usable in any environment. +Default implementation of a PresentationModel usable in most environments.

\ No newline at end of file