Alvin Thompson
Alvin Thompson

Reputation: 5448

are there java method naming conventions are in use for mutable `with`?

IMPORTANT: I am NOT asking for an opinion on what naming convention I should use. I want to know what naming conventions others have seen for the case below, in projects large and public enough to be noteworthy. Unfortunately, my Google searches have turned up nothing, probably because I don't already know any of the prefixes and therefore can't search for it by name.

I know that the with method prefix should be used to return a new instance of an immutable object, with its contents modified according to the specified object. However, I’m not aware of any naming convention for simply mutating a mutable object. Is anyone aware of any naming conventions for this and where they’re used?

If it matters, the problem I want to solve is I want to add a method that initializes the contents of an existing DTO, using a corresponding entity.

Upvotes: 0

Views: 306

Answers (1)

k_ssb
k_ssb

Reputation: 6252

I don't think there is a standard convention for the scenario you're describing. Take a look at a GsonBuilder (documentation here). There are many prefixes used, including "set", "add", "register", "enable", etc. They all just describe the method's behavior.

I would recommend using initializeFromEntity(entity) or something similar, since this describes what the method does -- you're initializing the DTO contents using an entity.

Searching Google for "Java initializeFrom" results in several usages (example, example).

Upvotes: 2

Related Questions