Skip to main content

Step-by-Step Explanation: Naming Backing Properties

Step-by-Step Explanation: Naming Backing Properties

The Kotlin Style Guide provides specific advice on how to name properties when you have a private "backing" property and a public "access" property for the same concept.

1. The Problem: Encapsulation vs API

Often, you want to maintain a mutable collection internally (so you can add/remove items) but expose it as a read-only collection to the rest of the world. - In Java, you'd use a private field List items and a getter getItems(). - In Kotlin, properties encompass both the field and the getter.

2. The Convention: The Underscore Prefix

If you have two properties that represent the same data: 1. The Private property (implementation detail) should be prefixed with an underscore (_). 2. The Public property (part of the API) should have a clean name without the underscore.

private val _items = mutableListOf<String>() // Implementation
val items: List<String> get() = _items        // Public API

3. Why This Matters

  • Readability: It's immediately clear which variable is the "real" source of truth and which is the public view.
  • Consistency: Following this standard ensures that your code looks like official Kotlin libraries (like the collections or Compose state libraries).
  • Safety: It prevents naming collisions while staying concise.

4. Verification

Verified by building the project. The implementation demonstrated that Inventory.items returns a read-only list, protecting the internal _items from unauthorized modifications from the outside.

Comments

Popular posts from this blog

Mastering Per-App Language Preferences: From Android 10 to Android 13+

  One of the most requested features by users is the ability to use an app in a language different from the system language. While Android 13 (API 33) introduced "Per-App Language" settings at the system level, implementing this backward-compatibly for older devices like Android 10 (API 29) used to be a challenge involving manual configuration wrapping. Today, thanks to AppCompat 1.6.0+ , we have a unified, standard way to handle this. Here is the modern guide to implementing seamless language switching. The Architecture: How it Works On Android 13 and above, the system handles the storage and application of your app's locale. On older versions, the AppCompat library manages this behavior by storing your preference in an internal XML file and injecting the resources during the activity lifecycle. Step 1: The Locale Helper Utility Instead of scattering logic across your app, use a clean LocaleHelper object. This handles the distinction between the system LocaleManager (...

Beyond Scanning: Meet the All-in-One AI Document Assistant by Digitify Vision Technology

In an era where efficiency is the ultimate currency, information is scattered everywhere—on physical paper, within QR codes, and inside lengthy digital documents. The challenge isn't just capturing this data; it’s making it work for you. At Digitify Vision Technology , we believe your smartphone should be more than just a camera—it should be a high-performance engine for your daily workflow. Today, we are proud to unveil our most powerful update yet: a total evolution in AI-driven document management. 💡 Key Features of the New Update We’ve bridged the gap between physical information and digital action by integrating advanced vision and audio intelligence into a single, seamless experience. 🔍 Precision Scanning for Everything Our advanced vision engine is now more versatile than ever. Intelligent Document Scanning: Capture crisp, professional-grade scans of physical papers, contracts, or handwritten notes. QR Code Extraction: Instantly scan any QR code to extract text, read URL...
  Optimising Android Launch: Mastering App Startup & The Modern Splash Screen The first few seconds of an app’s life determine a user's first impression. A slow start or a flickering white screen can lead to immediate uninstalls. In this guide, we’ll look at how to streamline your initialisation using the App Startup Library and ensure a seamless visual transition with the Android 12 Splash Screen API (with full backward compatibility for API 29). Part 1: The App Startup Library Traditionally, apps initialised multiple components using separate content providers. This adds overhead and slows down launch time. The Jetpack App Startup library allows all components to share a single content provider, significantly improving performance. Why use it? Performance: Shared content provider reduces overhead. Order: Explicitly set the initialisation sequence. Simplicity: Both library creators and app developers use a unified interface. Part 2: The Modern Splash Screen API Starting ...