Record Class ContentSiteBundle

java.lang.Object

java.lang.Record

io.mindspice.simplypages.components.content.ContentSiteBundle

public record ContentSiteBundle(Map<String, ContentSectionSite> sectionsByKey, ContentRouteIndex routeIndex, List<ContentWarning> warnings)
extends Record

Final static content bundle generated from configured section directories. Inspect warnings() after generation for nonfatal parsing and generation diagnostics, including detail routes that shadow another section's index. The warning list is immutable; warnings do not remove or reassign generated pages.

Constructor Summary

Constructors

Constructor	Description
ContentSiteBundle(Map<String, ContentSectionSite> sectionsByKey, ContentRouteIndex routeIndex, List<ContentWarning> warnings)	Creates an instance of a ContentSiteBundle record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
ContentRouteIndex	routeIndex()	Returns the value of the routeIndex record component.
Map<String, ContentSectionSite>	sectionsByKey()	Returns the value of the sectionsByKey record component.
final String	toString()	Returns a string representation of this record class.
List<ContentWarning>	warnings()	Returns the value of the warnings record component.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ContentSiteBundle

public ContentSiteBundle(Map<String, ContentSectionSite> sectionsByKey,
 ContentRouteIndex routeIndex,
 List<ContentWarning> warnings)

Creates an instance of a ContentSiteBundle record class.

Parameters:

sectionsByKey - the value for the sectionsByKey record component

routeIndex - the value for the routeIndex record component

warnings - the value for the warnings record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

sectionsByKey

public Map<String, ContentSectionSite> sectionsByKey()

Returns the value of the sectionsByKey record component.

Returns:

the value of the sectionsByKey record component

routeIndex

public ContentRouteIndex routeIndex()

Returns the value of the routeIndex record component.

Returns:

the value of the routeIndex record component

warnings

public List<ContentWarning> warnings()

Returns the value of the warnings record component.

Returns:

the value of the warnings record component