wvlet.airframe.surface.Surface.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of airframe-surface_sjs1_2.12 Show documentation

A library for extracting object structure surface

There is a newer version: 24.11.0

Show newest version

/*
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package wvlet.airframe.surface

import scala.language.existentials
import scala.language.experimental.macros

trait Surface extends Serializable {
  def rawType: Class[_]
  def typeArgs: Seq[Surface]
  def params: Seq[Parameter]
  def name: String
  def fullName: String

  def dealias: Surface = this

  def isOption: Boolean
  def isAlias: Boolean
  def isPrimitive: Boolean
  def isSeq: Boolean   = classOf[Seq[_]].isAssignableFrom(rawType)
  def isMap: Boolean   = classOf[Map[_, _]].isAssignableFrom(rawType)
  def isArray: Boolean = this.isInstanceOf[ArraySurface]

  /**
    * True if this surface is a Scala3 enum. In Scala 2, it always returns false
    */
  def isEnum: Boolean = false

  def objectFactory: Option[ObjectFactory] = None
  def withOuter(outer: AnyRef): Surface    = this
}

object Surface {
  private[surface] val scalaMajorVersion: Int = 2

  def of[A]: Surface = macro SurfaceMacros.surfaceOf[A]
  def methodsOf[A]: Seq[MethodSurface] = macro SurfaceMacros.methodSurfaceOf[A]
}