GYearMonthValue

java.lang.Object
- net.sf.saxon.value.Value
- - net.sf.saxon.value.AtomicValue
  - - net.sf.saxon.value.CalendarValue
    - - net.sf.saxon.value.GDateValue
      - net.sf.saxon.value.GYearMonthValue

All Implemented Interfaces:

java.io.Serializable, PullEvent, SequenceIterable, GroundedValue, Item, ValueRepresentation, ConversionResult
```
public class GYearMonthValue
extends GDateValue
```
Implementation of the xs:gYearMonth data type

See Also:

Serialized Form

Field Summary
- Fields inherited from class net.sf.saxon.value.AtomicValue
  typeLabel
- Fields inherited from class net.sf.saxon.value.CalendarValue
  NO_TIMEZONE
- Fields inherited from class net.sf.saxon.value.GDateValue
  day, daysPerMonth, month, monthData, year
- Fields inherited from class net.sf.saxon.value.Value
  EMPTY_CLASS_ARRAY, INDETERMINATE_ORDERING
- Fields inherited from interface net.sf.saxon.om.ValueRepresentation
  EMPTY_VALUE_ARRAY

Constructor Summary

Constructors
Constructor	Description
`GYearMonthValue(int year, byte month, int tz)`
`GYearMonthValue(int year, byte month, int tz, AtomicType type)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`CalendarValue`	`add(DurationValue duration)`	Add a duration to this date/time value
`CalendarValue`	`adjustTimezone(int tz)`	Return a new date, time, or dateTime with the same normalized value, but in a different timezone
`ConversionResult`	`convertPrimitive(BuiltInAtomicType requiredType, boolean validate, XPathContext context)`	Convert to target data type
`AtomicValue`	`copyAsSubType(AtomicType typeLabel)`	Make a copy of this date, time, or dateTime value
`BuiltInAtomicType`	`getPrimitiveType()`	Determine the primitive type of the value.
`java.lang.CharSequence`	`getStringValueCS()`	Get the value of the item as a CharSequence.
`static ConversionResult`	`makeGYearMonthValue(java.lang.CharSequence value)`

Methods inherited from class net.sf.saxon.value.AtomicValue
asAtomic, checkPermittedContents, convert, convert, effectiveBooleanValue, getCardinality, getItemType, getLength, getTypedValue, getTypeLabel, isNaN, itemAt, iterate, process, setTypeLabel, subsequence, toString

Methods inherited from class net.sf.saxon.value.CalendarValue
adjustTimezone, appendTimezone, appendTimezone, getStringValue, getTimezoneInMinutes, getXPathComparable, hasTimezone, removeTimezone, setTimezoneInMinutes, subtract

Methods inherited from class net.sf.saxon.value.GDateValue
compareTo, equals, getCalendar, getComparisonKey, getComponent, getDay, getMonth, getSchemaComparable, getYear, hashCode, isLeapYear, isValidDate, setLexicalValue, toDateTime

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from class net.sf.saxon.value.Value
asItem, asItem, asIterator, asValue, convertToJava, fromItem, getCanonicalLexicalRepresentation, getIterator, iterate, makeQNameValue, reduce, stringToNumber

- Constructor Detail
  - GYearMonthValue
```
public GYearMonthValue(int year,
                       byte month,
                       int tz)
```
  - GYearMonthValue
```
public GYearMonthValue(int year,
                       byte month,
                       int tz,
                       AtomicType type)
```
- Method Detail
  - makeGYearMonthValue
```
public static ConversionResult makeGYearMonthValue(java.lang.CharSequence value)
```
  - copyAsSubType
```
public AtomicValue copyAsSubType(AtomicType typeLabel)
```
    Make a copy of this date, time, or dateTime value
    
    Specified by:
    
    copyAsSubType in class AtomicValue
    
    Parameters:
    
    typeLabel -
    
    Returns:
    
    the copied value
  - getPrimitiveType
```
public BuiltInAtomicType getPrimitiveType()
```
    Determine the primitive type of the value. This delivers the same answer as getItemType().getPrimitiveItemType(). The primitive types are the 19 primitive types of XML Schema, plus xs:integer, xs:dayTimeDuration and xs:yearMonthDuration, and xs:untypedAtomic. For external objects, the result is AnyAtomicType.
    
    Specified by:
    
    getPrimitiveType in class AtomicValue
    
    Returns:
    
    the primitive type
  - convertPrimitive
```
public ConversionResult convertPrimitive(BuiltInAtomicType requiredType,
                                         boolean validate,
                                         XPathContext context)
```
    Convert to target data type
    
    Specified by:
    
    convertPrimitive in class AtomicValue
    
    Parameters:
    
    requiredType - an integer identifying the required atomic type
    
    context -
    
    validate - true if validation is required. If set to false, the caller guarantees that the value is valid for the target data type, and that further validation is therefore not required. Note that a validation failure may be reported even if validation was not requested.
    
    Returns:
    
    an AtomicValue, a value of the required type; or an ErrorValue
  - getStringValueCS
```
public java.lang.CharSequence getStringValueCS()
```
    Description copied from class: AtomicValue
    
    Get the value of the item as a CharSequence. This is in some cases more efficient than the version of the method that returns a String.
    
    Specified by:
    
    getStringValueCS in interface Item
    
    Specified by:
    
    getStringValueCS in interface ValueRepresentation
    
    Overrides:
    
    getStringValueCS in class AtomicValue
    
    Returns:
    
    the string value of the item
    
    See Also:
    
    Item.getStringValue()
  - add
```
public CalendarValue add(DurationValue duration)
                  throws XPathException
```
    Add a duration to this date/time value
    
    Specified by:
    
    add in class CalendarValue
    
    Parameters:
    
    duration - the duration to be added (which might be negative)
    
    Returns:
    
    a new date/time value representing the result of adding the duration. The original object is not modified.
    
    Throws:
    
    XPathException
  - adjustTimezone
```
public CalendarValue adjustTimezone(int tz)
```
    Return a new date, time, or dateTime with the same normalized value, but in a different timezone
    
    Specified by:
    
    adjustTimezone in class CalendarValue
    
    Parameters:
    
    tz - the new timezone, in minutes
    
    Returns:
    
    the date/time in the new timezone

Class GYearMonthValue

Field Summary

Fields inherited from class net.sf.saxon.value.AtomicValue

Fields inherited from class net.sf.saxon.value.CalendarValue

Fields inherited from class net.sf.saxon.value.GDateValue

Fields inherited from class net.sf.saxon.value.Value

Fields inherited from interface net.sf.saxon.om.ValueRepresentation

Constructor Summary

Method Summary

Methods inherited from class net.sf.saxon.value.AtomicValue

Methods inherited from class net.sf.saxon.value.CalendarValue

Methods inherited from class net.sf.saxon.value.GDateValue

Methods inherited from class java.lang.Object

Methods inherited from class net.sf.saxon.value.Value

Constructor Detail

GYearMonthValue

GYearMonthValue

Method Detail

makeGYearMonthValue

copyAsSubType

getPrimitiveType

convertPrimitive

getStringValueCS

add

adjustTimezone