1. Jason Stonebraker
  2. JSONExclusionMarshaller

Commits

Jason Stonebraker  committed 009e687

Edited online

  • Participants
  • Parent commits 1255c9b
  • Branches master

Comments (0)

Files changed (1)

File Home.md

View file
 
 The JSON Exclusion Marshaller is a Grails plugin that adds a convenience method to the Grails JSON converter for excluding class properties from the JSON converter's output.
 
+## Method Signature
+```
+#!groovy
+public static excludeFor*(Class class, List<String> propertiesToExclude)
+```
+
+#### Method Name
+**excludeFor*(...)** is a synthesized method. There are no restrictions or conventions for what you put in the place of the * wildcard, though it must be a valid method name.
+
+For instance, these are all valid:
+```
+#!groovy
+excludeForPublicAPI(...)
+excludeForRESTClientsThatDontNeedAllOfThePropertiesThisObjectContains(...)
+excludeForFoo(...)
+```
+
+As long as the method name you choose starts with "excludeFor", you're good to go.
+
+####Parameters:
+* class - The class of the object you will be excluding properties from.
+* propertiesToExclude - A list of the properties you want to be excluded from the JSON converter's output.
+
+
 ## Usage
 
 ```