R/credentials.R

In ChrisNice89/rdao: Data Access Object (DAO) framework for R

#' Class providing methods for creating a credential instance
#'
#' @docType class
#' @importFrom R6 R6Class
#' @keywords data
#' @family sql
#' @return Object of \code{\link{R6Class}} with methods user specified credentials (server)
#' @format \code{\link{R6Class}} object.
#' @examples
#' c<-Credentials$new(username = "Admin",password = "SesameOpen")
#'
#' @field username Readonly: Returns user name.
#' @field password Readonly: Returns user password.
#'
#' @section Methods:
#' \describe{}
#'
#' @include utils.R

Credentials <- R6Class(
  classname = "Credentials",
  private = list(
    .validator = NULL
  ),

  public = list(
    username = "",
    password = "",

    initialize = function(username = "",
                          password = "") {
      private$.validator <- Validator$new(self)

      if (!private$.validator$isNullString(username,throwError=TRUE)){
        self$username = username
      }

      if (!private$.validator$isNullString(password,throwError=TRUE)){
        self$password = password
      }

      private$.validator$makeReadonly("username", "password")
      invisible(self$print())
    },

    print = function(...) {
      cat("<",
          class(self)[1],
          "> for User: <",
          self$username,
          "> created",
          "\n",
          sep = "")
      invisible(self)
    }
  )
)