Jason Stonebraker avatar Jason Stonebraker committed 009e687

Edited online

Comments (0)

Files changed (1)

 
 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
 
 ```
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.