Skip to content

Commit ff67c3a

Browse files
SQiShERSQiShER
committed
Implemented SQiShER#64 (Provide Access to Annotations of Bean Properties)
1 parent 99479d9 commit ff67c3a

7 files changed

Lines changed: 105 additions & 1 deletion

File tree

‎src/main/java/de/danielbechler/diff/accessor/PropertyAccessor.java‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,12 @@
2121
import de.danielbechler.util.*;
2222
import org.slf4j.*;
2323

24+
import java.lang.annotation.*;
2425
import java.lang.reflect.*;
2526
import java.util.*;
2627

2728
/** @author Daniel Bechler */
28-
public final class PropertyAccessor extends AbstractAccessor implements TypeAwareAccessor
29+
public class PropertyAccessor extends AbstractAccessor implements TypeAwareAccessor
2930
{
3031
private static final Logger logger = LoggerFactory.getLogger(PropertyAccessor.class);
3132

@@ -192,6 +193,12 @@ public Element getPathElement()
192193
return new NamedPropertyElement(this.propertyName);
193194
}
194195

196+
/** @return The annotations of the getter used to access this property. */
197+
public Set<Annotation> getReadMethodAnnotations()
198+
{
199+
return new LinkedHashSet<Annotation>(Arrays.asList(readMethod.getAnnotations()));
200+
}
201+
195202
@Override
196203
public String toString()
197204
{

‎src/main/java/de/danielbechler/diff/node/DefaultNode.java‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,13 @@
2121
import de.danielbechler.diff.visitor.*;
2222
import de.danielbechler.util.*;
2323

24+
import java.lang.annotation.*;
2425
import java.util.*;
26+
import java.util.Collections;
2527
import java.util.concurrent.atomic.*;
2628

29+
import static java.util.Collections.*;
30+
2731
/** @author Daniel Bechler */
2832
public class DefaultNode implements Node
2933
{
@@ -281,6 +285,15 @@ public final void visitChildren(final Visitor visitor)
281285
}
282286
}
283287

288+
public Set<Annotation> getPropertyAnnotations()
289+
{
290+
if (accessor instanceof PropertyAccessor)
291+
{
292+
return unmodifiableSet(((PropertyAccessor) accessor).getReadMethodAnnotations());
293+
}
294+
return unmodifiableSet(Collections.<Annotation>emptySet());
295+
}
296+
284297
public final boolean isRootNode()
285298
{
286299
return accessor instanceof RootAccessor;

‎src/main/java/de/danielbechler/diff/node/Node.java‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
import de.danielbechler.diff.path.*;
2121
import de.danielbechler.diff.visitor.*;
2222

23+
import java.lang.annotation.*;
2324
import java.util.*;
2425

2526
/**
@@ -190,4 +191,11 @@ public enum State
190191
* @param visitor The visitor to use.
191192
*/
192193
void visitChildren(Visitor visitor);
194+
195+
/**
196+
* If this node represents a bean property this method returns all annotations of its getter.
197+
*
198+
* @return A set of annotations of this nodes property getter or an empty set.
199+
*/
200+
Set<Annotation> getPropertyAnnotations();
193201
}

‎src/test/java/de/danielbechler/diff/accessor/PropertyAccessorShould.java‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,14 @@
1919
import de.danielbechler.diff.accessor.exception.*;
2020
import de.danielbechler.diff.mock.*;
2121
import de.danielbechler.diff.path.*;
22+
import org.fest.assertions.api.*;
2223
import org.testng.annotations.*;
2324

25+
import java.lang.annotation.*;
2426
import java.lang.reflect.*;
27+
import java.util.*;
2528

29+
import static java.util.Arrays.*;
2630
import static org.fest.assertions.api.Assertions.*;
2731

2832
/** @author Daniel Bechler */
@@ -147,4 +151,18 @@ public void includes_accessor_type_in_string_representation()
147151
assertThat(accessor.toString()).startsWith("property ");
148152
}
149153

154+
@Test
155+
public void returns_annotations_of_getter_as_set() throws Exception
156+
{
157+
accessor = PropertyAccessorBuilder.forPropertyOf(ObjectWithAnnotatedProperty.class)
158+
.property("value", String.class)
159+
.readOnly(false)
160+
.build();
161+
final Annotation[] expectedAnnotations = ObjectWithAnnotatedProperty.class.getMethod("getValue")
162+
.getAnnotations();
163+
Assertions.assertThat(expectedAnnotations).hasSize(2);
164+
165+
final Set<Annotation> set = accessor.getReadMethodAnnotations();
166+
Assertions.assertThat(set).containsAll(asList(expectedAnnotations));
167+
}
150168
}

‎src/test/java/de/danielbechler/diff/mock/ObjectDiffTest.java‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
/*
2+
* Copyright 2013 Daniel Bechler
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package de.danielbechler.diff.mock;
18+
19+
import de.danielbechler.diff.annotation.*;
20+
21+
import java.lang.annotation.*;
22+
23+
/** @author Daniel Bechler */
24+
@Retention(RetentionPolicy.RUNTIME)
25+
@Target(ElementType.METHOD)
26+
@Inherited
27+
@ObjectDiffAnnotation
28+
public @interface ObjectDiffTest {
29+
}

‎src/test/java/de/danielbechler/diff/mock/ObjectWithAnnotatedProperty.java‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ public ObjectWithAnnotatedProperty(final String value)
3232
this.value = value;
3333
}
3434

35+
@ObjectDiffTest
3536
@ObjectDiffProperty(ignore = true)
3637
public String getValue()
3738
{

‎src/test/java/de/danielbechler/diff/node/DefaultNodeTest.java‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,11 @@
1818

1919
import de.danielbechler.diff.accessor.*;
2020
import de.danielbechler.diff.path.*;
21+
import org.fest.assertions.api.*;
2122
import org.hamcrest.core.*;
2223
import org.testng.annotations.*;
2324

25+
import java.lang.annotation.*;
2426
import java.util.*;
2527

2628
import static org.fest.assertions.api.Assertions.assertThat;
@@ -163,4 +165,30 @@ public void testAddChild_changes_node_state_to_changed_if_changed_child_node_get
163165
node.addChild(nodeMock);
164166
NodeAssertions.assertThat(node).root().hasState(Node.State.CHANGED);
165167
}
168+
169+
@Test
170+
public void testShould_return_property_annotations_of_property_accessor() throws Exception
171+
{
172+
final PropertyAccessor propertyAccessor = mock(PropertyAccessor.class);
173+
final Annotation annotation = mock(Annotation.class);
174+
when(propertyAccessor.getReadMethodAnnotations()).thenReturn(new LinkedHashSet<Annotation>(Arrays.asList(annotation)));
175+
final Node node = new DefaultNode(propertyAccessor, Object.class);
176+
177+
final Set<Annotation> annotations = node.getPropertyAnnotations();
178+
179+
Assertions.assertThat(annotations).containsAll(Arrays.asList(annotation));
180+
}
181+
182+
@Test
183+
public void testShould_return_empty_set_of_property_annotations_if_accessor_is_not_property_accessor() throws Exception
184+
{
185+
final PropertyAccessor propertyAccessor = mock(PropertyAccessor.class);
186+
final Annotation annotation = mock(Annotation.class);
187+
when(propertyAccessor.getReadMethodAnnotations()).thenReturn(new LinkedHashSet<Annotation>(Arrays.asList(annotation)));
188+
final Node node = new DefaultNode(propertyAccessor, Object.class);
189+
190+
final Set<Annotation> annotations = node.getPropertyAnnotations();
191+
192+
Assertions.assertThat(annotations).containsAll(Arrays.asList(annotation));
193+
}
166194
}

0 commit comments

Comments
 (0)