rspec/rules/S3546/java/parameters.adoc

20 lines
1.0 KiB
Plaintext
Raw Normal View History

=== Parameters
* key = constructor
** description: the fully-qualified name of a constructor that creates an open resource. An optional signature may be specified after the class name. E.G.
"org.assoc.res.MyResource" or "org.assoc.res.MySpecialResource(java.lang.String, int)"
* key: factoryMethod
** description: the fully-qualified name of a factory method that returns an open resource, with or without a parameter list. E.G. "org.assoc.res.ResourceFactory#create" or "org.assoc.res.SpecialResourceFactory #create(java.lang.String, int)"
* key: openingMethod
** description: the fully-qualified name of a method that opens an existing resource, with or without a parameter list. E.G.
"org.assoc.res.ResourceFactory#create" or "org.assoc.res.SpecialResourceFactory #create(java.lang.String, int)"
* key: closingMethod
** description: the fully-qualified name of the method which closes the open resource, with or without a parameter list. E.G. "org.assoc.res.MyResource#closeMe" or "org.assoc.res.MySpecialResource#closeMe(java.lang.String, int)"