{"id":36,"date":"2011-09-18T00:15:55","date_gmt":"2011-09-18T00:15:55","guid":{"rendered":"http:\/\/www.lexicalscope.com\/blog\/?p=36"},"modified":"2011-09-18T00:26:39","modified_gmt":"2011-09-18T00:26:39","slug":"introducing-fluent-reflection","status":"publish","type":"post","link":"https:\/\/www.lexicalscope.com\/blog\/2011\/09\/18\/introducing-fluent-reflection\/","title":{"rendered":"Introducing Fluent Reflection"},"content":{"rendered":"

I am in the processes of releasing the first alpha build of fluent-reflection, you can get the snapshot version from the fluent-reflection snapshot repository<\/a>.<\/p>\n

Motivation<\/h3>\n

Reflection code is difficult to write in Java, and even harder to read once it has been written. Although the Java Reflection API<\/a> allows complete access to the Java runtime type system, the complexity of using the Java Reflection API reduces its usefulness. I don’t want to have to write any more code like this:<\/p>\n

\r\nfinal List getMethods = new ArrayList();\r\n\r\nClass klass = Bean.class;\r\nwhile (klass != null) {\r\n   final Method[] declaredMethods = klass.getDeclaredMethods();\r\n   for (final Method method : declaredMethods) {\r\n      if (method.getName().startsWith(\"get\") && \r\n          method.getParameterTypes().length == 0 && \r\n          !method.getReturnType().equals(void.class)) {\r\n         getMethods.add(method);\r\n      }\r\n   }\r\n   klass = klass.getSuperclass();\r\n   [...]\r\n}\r\n<\/pre>\n
Solution<\/h3>\n
There are three APIs which have heavily influenced the design of the fluent-reflection API.<\/p>\n
    \n
  1. LambdaJ<\/a><\/li>\n
  2. Hamcrest<\/a><\/li>\n
  3. Jmock 2<\/a><\/li>\n<\/ol>\n
    All of them are examples of a style of API design known as fluent interfaces<\/a>. They use a combination of static methods, method chaining, generic methods, static factory methods and object scoping to produce a type safe and readable programming style.<\/p>\n
    In particular, the combination of method chaining and generic methods can help the user discover the usage of each part of the API and also takes advantage of Java’s static type system to prevent programming errors.<\/p>\n
    Using fluent-reflection the above code can be re-written in declarative style:<\/p>\n
    \r\nfinal List getMethods = \r\n   object(new Bean()).methods(\r\n      callableHasNameStartingWith(\"get\").\r\n      and(callableHasNoArguments()).\r\n      and(not(callableHasVoidReturn())));\r\n<\/pre>\n
    Extensibility<\/h3>\n
    The query methods in the API are given queries described by Hamcrest Matcher<\/a>s. So users can easily construct custom and reusable queries.<\/p>\n
    For example, this Matcher can select methods with a particular annotation:<\/p>\n
    \r\nclass MatcherAnnotatedWith extends ReflectionMatcher {\r\n    private final Class annotation;\r\n\r\n    public MatcherCallableAnnotatedWith(final Class annotation) {\r\n        this.annotation = annotation;\r\n    }\r\n\r\n    @Override protected boolean matchesSafely(final ReflectedAnnotated item) {\r\n        return item.annotation(reflectedTypeReflectingOn(annotation)) != null;\r\n    }\r\n\r\n    @Override public void describeTo(final Description description) {\r\n        description.appendText(\"callable annotated with \").appendValue(annotation);\r\n    }\r\n}\r\n<\/pre>\n
    Mashability<\/h3>\n
    Because the API uses the de facto standard Hamcrest matchers, and the Java collections framework it can be combined with other libraries in powerful ways. <\/p>\n
    For example, calling all of the @PostConstruct<\/code> methods on an Object using LambdaJ and fluent-reflection:<\/p>\n
    \r\nforEach(\r\n   object(subject).methods(annotatedWith(PostConstruct.class)),\r\n   ReflectedMethod.class).call();\r\n<\/pre>\n","protected":false},"excerpt":{"rendered":"
    I am in the processes of releasing the first alpha build of fluent-reflection, you can get the snapshot version from the fluent-reflection snapshot repository. Motivation Reflection code is difficult to write in Java, and even harder to read once it … Continue reading →<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"jetpack_post_was_ever_published":false,"_jetpack_newsletter_access":"","_jetpack_dont_email_post_to_subs":false,"_jetpack_newsletter_tier_id":0,"_jetpack_memberships_contains_paywalled_content":false,"_jetpack_memberships_contains_paid_content":false,"footnotes":"","jetpack_publicize_message":"","jetpack_publicize_feature_enabled":true,"jetpack_social_post_already_shared":false,"jetpack_social_options":{"image_generator_settings":{"template":"highway","default_image_id":0,"font":"","enabled":false},"version":2}},"categories":[6,7],"tags":[],"class_list":["post-36","post","type-post","status-publish","format-standard","hentry","category-fluent-reflection","category-software-projects"],"jetpack_publicize_connections":[],"jetpack_featured_media_url":"","jetpack_shortlink":"https:\/\/wp.me\/p2e3P7-A","jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/www.lexicalscope.com\/blog\/wp-json\/wp\/v2\/posts\/36","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.lexicalscope.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.lexicalscope.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.lexicalscope.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.lexicalscope.com\/blog\/wp-json\/wp\/v2\/comments?post=36"}],"version-history":[{"count":10,"href":"https:\/\/www.lexicalscope.com\/blog\/wp-json\/wp\/v2\/posts\/36\/revisions"}],"predecessor-version":[{"id":46,"href":"https:\/\/www.lexicalscope.com\/blog\/wp-json\/wp\/v2\/posts\/36\/revisions\/46"}],"wp:attachment":[{"href":"https:\/\/www.lexicalscope.com\/blog\/wp-json\/wp\/v2\/media?parent=36"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.lexicalscope.com\/blog\/wp-json\/wp\/v2\/categories?post=36"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.lexicalscope.com\/blog\/wp-json\/wp\/v2\/tags?post=36"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}