Package com.ibm.fhir.model.type

Class Period

java.lang.Object

com.ibm.fhir.model.visitor.AbstractVisitable

com.ibm.fhir.model.type.Element

com.ibm.fhir.model.type.Period

All Implemented Interfaces:

Visitable

@Generated("com.ibm.fhir.tools.CodeGenerator")
public class Period
extends Element

A time period defined by a start and end date and optionally time.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Period.Builder

Field Summary

Fields inherited from class com.ibm.fhir.model.type.Element

extension, id

Method Summary

Modifier and Type	Method	Description
void	accept(String elementName, int elementIndex, Visitor visitor)	Accept a Visitor and invoke the appropriate visit methods.
static Period.Builder	builder()
boolean	equals(Object obj)
DateTime	getEnd()	The end of the period.
DateTime	getStart()	The start of the period.
boolean	hasChildren()
int	hashCode()
Period.Builder	toBuilder()	Create a new Builder from the contents of this Element

Methods inherited from class com.ibm.fhir.model.type.Element

as, getExtension, getId, hasValue, is

Methods inherited from class com.ibm.fhir.model.visitor.AbstractVisitable

accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ibm.fhir.model.visitor.Visitable

accept, accept

Method Detail

getStart

public DateTime getStart()

The start of the period. The boundary is inclusive.

Returns:

An immutable object of type DateTime that may be null.

getEnd

public DateTime getEnd()

The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

Returns:

An immutable object of type DateTime that may be null.

hasChildren

public boolean hasChildren()

Overrides:

hasChildren in class Element

accept

public void accept(String elementName,
                   int elementIndex,
                   Visitor visitor)

Description copied from interface: Visitable

Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this:

 if (visitor.preVisit(this)) {
     visitor.visitStart(elementName, elementIndex, this);
     if (visitor.visit(elementName, elementIndex, this)) {
         // visit children
     }
     visitor.visitEnd(elementName, elementIndex, this);
     visitor.postVisit(this);
 }
 

Specified by:

accept in interface Visitable

Specified by:

accept in class AbstractVisitable

Parameters:

elementName - the name of the element in the context of this visit

elementIndex - the index of the element in a list or -1 if it is not contained within a List

visitor - the visitor to use

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toBuilder

public Period.Builder toBuilder()

Description copied from class: Element

Create a new Builder from the contents of this Element

Specified by:

toBuilder in class Element

builder

public static Period.Builder builder()