com.hp.jipp.encoding.Attribute.kt Maven / Gradle / Ivy
// Copyright 2017 HP Development Company, L.P.
// SPDX-License-Identifier: MIT
package com.hp.jipp.encoding
import com.hp.jipp.util.PrettyPrintable
import com.hp.jipp.util.PrettyPrinter
import com.hp.jipp.util.toHexString
import java.text.SimpleDateFormat
import java.util.* // ktlint-disable
/**
* An IPP attribute, which is a named, ordered list of 0 or more values.
*
* Values are parsed into the most natural Java type that can encode the supplied data.
*/
interface Attribute : PrettyPrintable, List {
/** The name of the attribute. */
val name: String
/** Attribute type. */
val type: AttributeType
/** Return values in string form. */
fun strings(): List = map { if (it is Stringable) it.asString() else it.toString() }
/** True if the tag for this attribute is [Tag.unknown] */
fun isUnknown() = (type as? EmptyAttributeType)?.tag == Tag.unknown
/** True if the tag for this attribute is [Tag.noValue] */
fun isNoValue() = (type as? EmptyAttributeType)?.tag == Tag.noValue
/** True if the tag for this attribute is [Tag.unsupported] */
fun isUnsupported() = (type as? EmptyAttributeType)?.tag == Tag.unsupported
/** Returns the first value in the attribute if present. */
fun getValue(): T?
override fun print(printer: PrettyPrinter) {
when (size) {
0 -> printer.open(PrettyPrinter.SILENT, name + (this as? EmptyAttribute)?.let { " (${it.tag})" })
1 -> printer.open(PrettyPrinter.KEY_VALUE, "$name =")
else -> printer.open(PrettyPrinter.ARRAY, "$name =")
}
forEach {
when (it) {
is PrettyPrintable -> printer.add(it)
else -> printer.add(toPrintable(it))
}
}
printer.close()
}
/** Convert a value to a printable object */
private fun toPrintable(value: T): String = when (value) {
// Present Calendar as an ISO6801 date string
is Calendar -> SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss.SSS'Z'").let { format ->
format.timeZone = value.timeZone
format.format(value.time)
}
is ByteArray -> "0x" + value.toHexString()
else -> value.toString()
}
}