Документация по репутации

Я реализую структуру данных графа в java. В этой структуре вершины представлены как объекты Vertex, содержащие частное конечное поле значения String.

Один из моих методов vertices() возвращает набор значений всех вершин. В частности, клиент, который получает этот набор, не может получить конкретное значение из набора и установить его в другую строку (из-за модификатора final). Как мне задокументировать это поведение в javadocs vertices()?


java graph data-structures
person Ray    schedule 28.12.2020    source источник
comment
Какова подпись метода vertices()?   -  person tgdavies    schedule 29.12.2020
comment
public Set‹String› вершины()   -  person Ray    schedule 29.12.2020

Ответы (1)


arrow_upward
1
arrow_downward

К сожалению, стандартная библиотека Java не имеет интерфейса для неизменяемых коллекций.

Я думаю, что все, что вы можете сделать, это обернуть набор, который вы возвращаете, в UnmodifiableSet через Collections.unmodifiableSet и упомянуть в Javadoc, что возвращаемый набор неизменен.

person tgdavies    schedule 28.12.2020