ddanielr commented on issue #3981:
URL: https://github.com/apache/accumulo/issues/3981#issuecomment-1894954214

   So I took some more time with this and figured out a way to add example 
properties to Property.java. 
   
   I didn't want to add defaultValues for properties that we actually didn't 
want set.
   There has been code before that checks to see if the user set the property 
and only does things if that is true vs the property being in the default 
configuration. 
   
   That pattern seems to add additional complexity to our code while also 
confusing users who might set the property just because we have it listed as a 
default and they want to hedge against the  property  changing in the default 
configuration. 
   
   So I added two things. The first is an `@Example` annotation which marks the 
property has an example prop. This means the property is excluded from the 
DefaultConfiguration generation and also adds different property documentation 
details. The second is another value field called `exampleValue`. This was done 
to ensure that if an annotation is mistakenly removed, the property still has 
no way of impacting a system.
   
   The annotation must be removed, and the default value updated in order for 
the property to be included in the DefaultConfiguration. 
   
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to