Record Class DoctorAdvisory

java.lang.Object

java.lang.Record

com.shaft.doctor.model.DoctorAdvisory

Record Components:

schemaVersion - Doctor advisory envelope schema version

status - advisory outcome

analysis - schema-validated provider analysis

metadata - safe provider and fallback metadata

public record DoctorAdvisory(String schemaVersion, DoctorAdvisory.Status status, DoctorAdvisory.ProviderAnalysis analysis, DoctorAdvisory.Metadata metadata)
extends Record

Separately identified optional provider advisory that never replaces the deterministic diagnosis.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	DoctorAdvisory.Hypothesis	One provider hypothesis.
static final record	DoctorAdvisory.Metadata	Safe provider, timing, usage, cache, and fallback metadata.
static final record	DoctorAdvisory.Observation	One provider observation.
static final record	DoctorAdvisory.ProviderAnalysis	Versioned provider output accepted by Doctor.
static final record	DoctorAdvisory.RecommendedAction	One provider-recommended action.
static enum	DoctorAdvisory.Status	Advisory outcome.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CURRENT_SCHEMA_VERSION	Current advisory envelope schema version.

Constructor Summary

Constructors

Constructor	Description
DoctorAdvisory(String schemaVersion, DoctorAdvisory.Status status, DoctorAdvisory.ProviderAnalysis analysis, DoctorAdvisory.Metadata metadata)	Creates a validated advisory.

Method Summary

Modifier and Type	Method	Description
DoctorAdvisory.ProviderAnalysis	analysis()	Returns the value of the analysis record component.
static DoctorAdvisory	disabled()	Returns a disabled advisory that is not rendered into deterministic reports.
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.
DoctorAdvisory.Metadata	metadata()	Returns the value of the metadata record component.
String	schemaVersion()	Returns the value of the schemaVersion record component.
DoctorAdvisory.Status	status()	Returns the value of the status record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Field Details

CURRENT_SCHEMA_VERSION

public static final String CURRENT_SCHEMA_VERSION

Current advisory envelope schema version.

See Also:

• Constant Field Values

Constructor Details

DoctorAdvisory

public DoctorAdvisory(String schemaVersion,
 DoctorAdvisory.Status status,
 DoctorAdvisory.ProviderAnalysis analysis,
 DoctorAdvisory.Metadata metadata)

Creates a validated advisory.

Method Details

disabled

public static DoctorAdvisory disabled()

Returns a disabled advisory that is not rendered into deterministic reports.

Returns:

disabled advisory

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.

schemaVersion

public String schemaVersion()

Returns the value of the schemaVersion record component.

Returns:

the value of the schemaVersion record component

status

public DoctorAdvisory.Status status()

Returns the value of the status record component.

Returns:

the value of the status record component

analysis

public DoctorAdvisory.ProviderAnalysis analysis()

Returns the value of the analysis record component.

Returns:

the value of the analysis record component

metadata

public DoctorAdvisory.Metadata metadata()

Returns the value of the metadata record component.

Returns:

the value of the metadata record component