Tutorial

Kotlin Visibility Modifiers - public, protected, internal, private

Published on August 3, 2022
Default avatar

By Anupam Chugh

Kotlin Visibility Modifiers - public, protected, internal, private

While we believe that this content benefits our community, we have not yet thoroughly reviewed it. If you have any suggestions for improvements, please let us know by clicking the “report an issue“ button at the bottom of the tutorial.

In this tutorial, we’ll be discussing the various Visibility Modifiers available in Kotlin programming.

Kotlin Visibility Modifiers

Visibility Modifiers are modifiers that when appended to a class/interface/property/function in Kotlin, would define where all it is visible and from where all it can be accessed. The setters of properties in Kotlin can have a separate modifier from the property. The getters can’t have a visibility modifier defined. They use the same modifier as that of the property. Following are the visibility modifiers:

  • public
  • protected
  • internal
  • private

Public Modifier

A Public Modifier is the default modifier in Kotlin. Just like the Java public modifier, it means that the declaration is visible everywhere.


class Hello{
}

public class H{
}

fun hi()
public fun hello()

val i = 0
public val j = 5

All the above declarations are the in the top level of the file. ALL are public. If we don’t mention the declaration of the members of the class, they are public(unless they are overridden).

Protected Modifier

A Protected Modifier in Kotlin: CANNOT be set on top-level declarations. Declarations that are protected in a class, can be accessed only in their subclasses. kotlin visibility modifiers, kotlin protected modifier

open class Pr{
    protected val i = 0
}

class Another : Pr{

    fun iValue() : Int
    {
        return i
    }
}

Classes which are not a subclass of Pr cannot access i Declarations that are protected, when overridden would have the same protected modifier in the subclass unless you explicitly change them.

open class Pr{
    open protected val i = 0
}

class Another : Pr(){

    fun iValue() : Int
    {
        return i
    }
    
    override val i = 5 //protected visibility
}

The concept of Protected Modifiers in Kotlin that’s defined above differs from that in Java.

Internal Modifier

Internal is a new modifier available in Kotlin that’s not there in Java. Setting a declaration as internal means that it’ll be available in the same module only. By module in Kotlin, we mean a group of files that are compiled together.

internal class A {
}

internal val x = 0

These won’t be visible outside the current module. Internal Modifiers is useful when you need to hide specific library implementations from the users. This wasn’t possible using the package-private visibility in Java.

Private Modifiers

Private Modifiers do not allow the declarations to be visible outside the current scope.

var setterVisibility: String = "abc"
private set

open class Pr{
    open protected val i = 0

    fun iValue() : Int
    {
        setterVisibility = 10
        return setterVisibility
    }
}

Since kotlin allows multiple top level definitions the above code works. The below doesn’t

private open class ABC{
    private val x = 6
}

private class BDE : ABC()
{
    fun getX()
    {
        return x //x cannot be accessed here.
    }
}

x is visibile only from inside its class. We can set private constructors in the following way:

class PRIV private constructor(a: String) {
 ... 
}

By default classes have public constructors. Wherever the class goes the constructor follows. We need to set the visibility modifier on the constructor in the definition itself. Thus Kotlin uses the protected and internal modifiers differently from Java. Also Java’s default modifier is package-private which doesn’t exist in Kotlin, yet. This brings an end to this quick tutorial on Visibility Modifiers in Kotlin.

Thanks for learning with the DigitalOcean Community. Check out our offerings for compute, storage, networking, and managed databases.

Learn more about us


About the authors
Default avatar
Anupam Chugh

author

Still looking for an answer?

Ask a questionSearch for more help

Was this helpful?
 
JournalDev
DigitalOcean Employee
DigitalOcean Employee badge
January 31, 2020

am not clear about internal modifier can you please explain?

- nagaraj

    Try DigitalOcean for free

    Click below to sign up and get $200 of credit to try our products over 60 days!

    Sign up

    Join the Tech Talk
    Success! Thank you! Please check your email for further details.

    Please complete your information!

    Get our biweekly newsletter

    Sign up for Infrastructure as a Newsletter.

    Hollie's Hub for Good

    Working on improving health and education, reducing inequality, and spurring economic growth? We'd like to help.

    Become a contributor

    Get paid to write technical tutorials and select a tech-focused charity to receive a matching donation.

    Welcome to the developer cloud

    DigitalOcean makes it simple to launch in the cloud and scale up as you grow — whether you're running one virtual machine or ten thousand.

    Learn more
    DigitalOcean Cloud Control Panel