Nathan Baulch 9f1fa0e440
Fix another batch of spelling typos (#13915)
* Fix typos

* Remove repeated words

* Minor grammar fixes
2022-11-07 21:30:24 +08:00

266 lines
7.9 KiB
R

#' Create a new Cat
#'
#' @description
#' Cat Class
#'
#' @docType class
#' @title Cat
#' @description Cat Class
#' @format An \code{R6Class} generator object
#' @field className character
#' @field color character [optional]
#' @field declawed character [optional]
#' @field _field_list a list of fields list(character)
#' @field additional_properties additional properties list(character) [optional]
#' @importFrom R6 R6Class
#' @importFrom jsonlite fromJSON toJSON
#' @export
Cat <- R6::R6Class(
"Cat",
inherit = Animal,
public = list(
`className` = NULL,
`color` = NULL,
`declawed` = NULL,
`_field_list` = c("className", "color", "declawed"),
`additional_properties` = list(),
#' Initialize a new Cat class.
#'
#' @description
#' Initialize a new Cat class.
#'
#' @param className className
#' @param color color. Default to "red".
#' @param declawed declawed
#' @param additional_properties additional properties (optional)
#' @param ... Other optional arguments.
#' @export
initialize = function(`className`, `color` = "red", `declawed` = NULL, additional_properties = NULL, ...) {
if (!missing(`className`)) {
if (!(is.character(`className`) && length(`className`) == 1)) {
stop(paste("Error! Invalid data for `className`. Must be a string:", `className`))
}
self$`className` <- `className`
}
if (!is.null(`color`)) {
if (!(is.character(`color`) && length(`color`) == 1)) {
stop(paste("Error! Invalid data for `color`. Must be a string:", `color`))
}
self$`color` <- `color`
}
if (!is.null(`declawed`)) {
if (!(is.logical(`declawed`) && length(`declawed`) == 1)) {
stop(paste("Error! Invalid data for `declawed`. Must be a boolean:", `declawed`))
}
self$`declawed` <- `declawed`
}
if (!is.null(additional_properties)) {
for (key in names(additional_properties)) {
self$additional_properties[[key]] <- additional_properties[[key]]
}
}
},
#' To JSON string
#'
#' @description
#' To JSON String
#'
#' @return Cat in JSON format
#' @export
toJSON = function() {
CatObject <- list()
if (!is.null(self$`className`)) {
CatObject[["className"]] <-
self$`className`
}
if (!is.null(self$`color`)) {
CatObject[["color"]] <-
self$`color`
}
if (!is.null(self$`declawed`)) {
CatObject[["declawed"]] <-
self$`declawed`
}
for (key in names(self$additional_properties)) {
CatObject[[key]] <- self$additional_properties[[key]]
}
CatObject
},
#' Deserialize JSON string into an instance of Cat
#'
#' @description
#' Deserialize JSON string into an instance of Cat
#'
#' @param input_json the JSON input
#' @return the instance of Cat
#' @export
fromJSON = function(input_json) {
this_object <- jsonlite::fromJSON(input_json)
if (!is.null(this_object$`className`)) {
self$`className` <- this_object$`className`
}
if (!is.null(this_object$`color`)) {
self$`color` <- this_object$`color`
}
if (!is.null(this_object$`declawed`)) {
self$`declawed` <- this_object$`declawed`
}
# process additional properties/fields in the payload
for (key in names(this_object)) {
if (!(key %in% self$`_field_list`)) { # json key not in list of fields
self$additional_properties[[key]] <- this_object[[key]]
}
}
self
},
#' To JSON string
#'
#' @description
#' To JSON String
#'
#' @return Cat in JSON format
#' @export
toJSONString = function() {
jsoncontent <- c(
if (!is.null(self$`className`)) {
sprintf(
'"className":
"%s"
',
self$`className`
)
},
if (!is.null(self$`color`)) {
sprintf(
'"color":
"%s"
',
self$`color`
)
},
if (!is.null(self$`declawed`)) {
sprintf(
'"declawed":
%s
',
tolower(self$`declawed`)
)
}
)
jsoncontent <- paste(jsoncontent, collapse = ",")
json_string <- as.character(jsonlite::minify(paste("{", jsoncontent, "}", sep = "")))
json_obj <- jsonlite::fromJSON(json_string)
for (key in names(self$additional_properties)) {
json_obj[[key]] <- self$additional_properties[[key]]
}
json_string <- as.character(jsonlite::minify(jsonlite::toJSON(json_obj, auto_unbox = TRUE, digits = NA)))
},
#' Deserialize JSON string into an instance of Cat
#'
#' @description
#' Deserialize JSON string into an instance of Cat
#'
#' @param input_json the JSON input
#' @return the instance of Cat
#' @export
fromJSONString = function(input_json) {
this_object <- jsonlite::fromJSON(input_json)
self$`className` <- this_object$`className`
self$`color` <- this_object$`color`
self$`declawed` <- this_object$`declawed`
# process additional properties/fields in the payload
for (key in names(this_object)) {
if (!(key %in% self$`_field_list`)) { # json key not in list of fields
self$additional_properties[[key]] <- this_object[[key]]
}
}
self
},
#' Validate JSON input with respect to Cat
#'
#' @description
#' Validate JSON input with respect to Cat and throw an exception if invalid
#'
#' @param input the JSON input
#' @export
validateJSON = function(input) {
input_json <- jsonlite::fromJSON(input)
# check the required field `className`
if (!is.null(input_json$`className`)) {
if (!(is.character(input_json$`className`) && length(input_json$`className`) == 1)) {
stop(paste("Error! Invalid data for `className`. Must be a string:", input_json$`className`))
}
} else {
stop(paste("The JSON input `", input, "` is invalid for Cat: the required field `className` is missing."))
}
},
#' To string (JSON format)
#'
#' @description
#' To string (JSON format)
#'
#' @return String representation of Cat
#' @export
toString = function() {
self$toJSONString()
},
#' Return true if the values in all fields are valid.
#'
#' @description
#' Return true if the values in all fields are valid.
#'
#' @return true if the values in all fields are valid.
#' @export
isValid = function() {
# check if the required `className` is null
if (is.null(self$`className`)) {
return(FALSE)
}
TRUE
},
#' Return a list of invalid fields (if any).
#'
#' @description
#' Return a list of invalid fields (if any).
#'
#' @return A list of invalid fields (if any).
#' @export
getInvalidFields = function() {
invalid_fields <- list()
# check if the required `className` is null
if (is.null(self$`className`)) {
invalid_fields["className"] <- "Non-nullable required field `className` cannot be null."
}
invalid_fields
},
#' Print the object
#'
#' @description
#' Print the object
#'
#' @export
print = function() {
print(jsonlite::prettify(self$toJSONString()))
invisible(self)
}
),
# Lock the class to prevent modifications to the method or field
lock_class = TRUE
)
## Uncomment below to unlock the class to allow modifications of the method or field
# Cat$unlock()
#
## Below is an example to define the print function
# Cat$set("public", "print", function(...) {
# print(jsonlite::prettify(self$toJSONString()))
# invisible(self)
# })
## Uncomment below to lock the class to prevent modifications to the method or field
# Cat$lock()