Конструкции языка Java, указывающие, что аргумент не будет мутирован?

Question

У меня есть метод, который принимает несколько аргументов, некоторые из этих аргументов будут изменены внутри метода. Некоторые из них используются только для чтения. Клиент (другие части кода, вызывающие такой метод) предоставляет экземпляры объектов в качестве аргументов.

Какие существуют конструкции языка Java, которые позволяют мне заявить, что аргумент не должен или не будет или не может быть мутирован внутри метода. Constrcuts как аннотации или ключевые слова, которые говорят клиенту, что метод не будет изменять экземпляры объектов, используемые в качестве аргументов в вызове метода. Также создаются конструкции, которые генерировали бы ошибки компиляции или предупреждение в случае, если я (как разработчик такого метода) попытаюсь случайно мутировать объект внутри реализации метода.

Я знаю о ключевом слове final, но это только для того, чтобы ссылка не обновлялась.

Неизменность - это не решение, как в других методах (или где-либо еще в моем приложении). Я хочу, чтобы экземпляры типа изменялись, только внутри этого вызова метода я хочу дать «обещание» клиенту , что я не буду изменять свой экземпляр, предоставленный в качестве аргумента.

Глубокое копирование или клонирование аргумента или разрешение клиенту (вызывающему) сделать такую ​​вещь не требуется, так как она не является частью логики метода, чтобы каким-либо образом изменить экземпляр. Я просто хочу узнать, поможет ли язык двойной проверки, этого не произойдет.

Answer 1

Невозможно определить аргумент только для чтения (только то, что вы уже упоминали). Тем не менее, вы можете использовать builder pattern для создания переданного объекта, чтобы встроенный объект имел только методы getter, поэтому он не будет иметь методы setter, что делает его эффективно неизменным (обратите внимание, что отражение по-прежнему может использоваться для изменения его полей) ,

Answer 2

Вы ищете неизменяемость. final гарантирует, что ссылка не может быть обновлена, но изменяемые поля все еще могут быть изменены. Путем создания экземпляров класса неизменяемым вы можете гарантировать, что значение экземпляра никогда не изменится.

Проверить strategy for defining immutable Objects

Если вы не хотите, чтобы ваши экземпляры неизменны, вы можете дать клиенту гарантию, что объект представлен им не изменится, передавая защитную копию/экземпляр с глубоким копированием.

Answer 3

Для вас нет чистого Java-решения.

Как вы упомянули, ключевое слово final будет гарантировать, что для этой ссылки не может быть назначено новое значение.

Одна предосторожность, которую вы можете использовать, - это клонировать или обертывать ваши изменяемые аргументы в зависимости от случая.

Есть некоторые (громоздкие) методы, доступные для глубоких клонов коллекций и карт (см. here и here для быстрого примера в SO).

В конечном счете, хорошо представленный и тщательный javadoc может обеспечить соответствующий уровень документации здесь.