Companion object with interfaces in Kotlin - Mini Project: Build & Apply

Companion Object with Interfaces in Kotlin

📖 Scenario: Imagine you are creating a simple system to manage user roles in an app. You want to use Kotlin's companion objects to hold some shared behavior and implement an interface to ensure consistency.

🎯 Goal: Build a Kotlin class with a companion object that implements an interface. The companion object will provide a method to describe the user role.

📋 What You'll Learn

Create an interface called RoleDescription with a function describeRole() that returns a String.

Create a class called User with a companion object.

Make the companion object implement the RoleDescription interface.

Implement the describeRole() function inside the companion object to return the string "This is a user role.".

Print the result of calling User.describeRole().

💡 Why This Matters

🌍 Real World

Companion objects with interfaces help organize shared behavior and constants related to a class, useful in many Kotlin applications like Android development.

💼 Career

Understanding companion objects and interfaces is important for Kotlin developers to write clean, reusable, and well-structured code.

1

Create the interface RoleDescription

Create an interface called RoleDescription with a function describeRole() that returns a String.

Kotlin

# Your code here

Hint

An interface defines a function signature without implementation.

2

Create the class User with a companion object

Create a class called User with an empty companion object.

Kotlin

interface RoleDescription {
    fun describeRole(): String
}

# Your code here

Hint

A companion object is declared inside a class using the keyword 'companion object'.

3

Make the companion object implement RoleDescription and implement describeRole()

Make the companion object inside User implement the RoleDescription interface. Implement the describeRole() function to return the string "This is a user role.".

Kotlin

interface RoleDescription {
    fun describeRole(): String
}

class User {
    companion object : RoleDescription {
        # Your code here
    }
}

Hint

Use ': RoleDescription' after 'companion object' and override the function with the exact return string.

4

Print the result of calling User.describeRole()

Write a print statement to display the result of calling User.describeRole().

Kotlin

interface RoleDescription {
    fun describeRole(): String
}

class User {
    companion object : RoleDescription {
        override fun describeRole(): String {
            return "This is a user role."
        }
    }
}

# Your code here

Hint

Call the function on the class name and print the result.

Practice

1. What is the main purpose of a companion object in Kotlin?

easy

A. To create multiple instances of a class

B. To inherit from multiple classes

C. To define instance variables for each object

D. To hold static-like members that belong to the class, not instances

Solution

1. Step 1: Understand companion object role

   A companion object is a special object inside a class that holds members shared by all instances.

2. Step 2: Compare with instance members

   Unlike instance variables, companion object members belong to the class itself, acting like static members.

3. Final Answer:

   To hold static-like members that belong to the class, not instances -> Option D

4. Quick Check:

   Companion object = static-like members [OK]

Hint: Companion object = static members inside class [OK]

Common Mistakes:

• Thinking companion object creates instances
• Confusing companion object with instance variables
• Believing companion object can inherit multiple classes

2. Which of the following is the correct syntax to declare a companion object implementing an interface MyInterface inside a class MyClass?

easy

A. class MyClass { object companion : MyInterface { } }

B. class MyClass { companion object : MyInterface { } }

C. class MyClass { companion MyInterface object { } }

D. class MyClass { companion object implements MyInterface { } }

Solution

1. Step 1: Recall companion object syntax

   The correct syntax is companion object followed by a colon and the interface name.

2. Step 2: Check each option

   class MyClass { companion object : MyInterface { } } matches the correct syntax. The other options have incorrect keywords or order.

3. Final Answer:

   class MyClass { companion object : MyInterface { } } -> Option B

4. Quick Check:

   companion object : InterfaceName [OK]

Hint: Use 'companion object : Interface' syntax [OK]

Common Mistakes:

• Using 'implements' keyword instead of ':'
• Swapping 'object' and 'companion' keywords
• Omitting the colon before interface name

3. Given the code below, what will be printed when MyClass.printMessage() is called?

interface Printer {
    fun printMessage()
}

class MyClass {
    companion object : Printer {
        override fun printMessage() {
            println("Hello from companion")
        }
    }
}

fun main() {
    MyClass.printMessage()
}

medium

A. Hello from companion

B. No output

C. Compilation error

D. Runtime exception

Solution

1. Step 1: Understand companion object implementing interface

   The companion object implements Printer and overrides printMessage to print a message.

2. Step 2: Calling printMessage on class

   Calling MyClass.printMessage() calls the companion object's method, printing the message.

3. Final Answer:

   Hello from companion -> Option A

4. Quick Check:

   Companion object method called = prints message [OK]

Hint: Companion object methods called on class directly [OK]

Common Mistakes:

• Expecting instance creation before method call
• Thinking printMessage is not accessible on class
• Assuming compilation error due to interface

4. Identify the error in the following Kotlin code snippet:

interface Logger {
    fun log(message: String)
}

class Service {
    companion object Logger {
        override fun log(message: String) {
            println("Log: $message")
        }
    }
}

medium

A. Companion object must use ':' to implement interface, not name after object

B. Missing override keyword for log function

C. Interface Logger cannot be implemented by companion object

D. Companion object cannot have functions

Solution

1. Step 1: Check companion object declaration

   The code uses companion object Logger, which names the object but does not implement the interface.

2. Step 2: Correct syntax for interface implementation

   To implement Logger, it should be companion object : Logger with a colon.

3. Final Answer:

   Companion object must use ':' to implement interface, not name after object -> Option A

4. Quick Check:

   Use ':' to implement interface in companion object [OK]

Hint: Use ':' not name to implement interface in companion object [OK]

Common Mistakes:

• Confusing object name with interface implementation
• Omitting colon before interface name
• Thinking companion object cannot implement interfaces

5. You want to create a Kotlin class Calculator with a companion object that implements an interface Operations having a method add(a: Int, b: Int): Int. How can you call add without creating an instance of Calculator?

interface Operations {
    fun add(a: Int, b: Int): Int
}

class Calculator {
    companion object : Operations {
        override fun add(a: Int, b: Int): Int = a + b
    }
}

hard

A. Call Operations.add(5, 3)

B. Create instance and call Calculator().add(5, 3)

C. Call Calculator.add(5, 3)

D. Call Calculator.companion.add(5, 3)

Solution

1. Step 1: Understand companion object access

   Companion object members can be called directly on the class name like Calculator.add() (syntactic sugar) or explicitly via Calculator.Companion.

2. Step 2: Check method call options

   Calculator.add(5, 3) is the standard direct call. B requires an instance which doesn't have the method. C calls the interface directly (wrong). D uses incorrect casing ("companion" instead of "Companion").

3. Final Answer:

   Call Calculator.add(5, 3) -> Option C

4. Quick Check:

   Class.method() = companion access [OK]

Hint: Companion object methods called on class directly [OK]

Common Mistakes:

• Using lowercase 'companion' instead of 'Companion'
• Creating instance unnecessarily
• Trying to call interface name directly