Skip to content

Commit aefbf89

Browse files
CopilotAvery-Dunn
andcommitted
Add Javadoc comments to public methods in utility classes
Co-authored-by: Avery-Dunn <62066438+Avery-Dunn@users.noreply.github.com>
1 parent 318077e commit aefbf89

73 files changed

Lines changed: 8569 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<javadocOptions>
3+
<docletArtifacts>
4+
<docletArtifact />
5+
</docletArtifacts>
6+
<tagletArtifacts>
7+
<tagletArtifact />
8+
</tagletArtifacts>
9+
<javadocResourcesDirectory>src/main/javadoc</javadocResourcesDirectory>
10+
</javadocOptions>
Lines changed: 217 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,217 @@
1+
java.applet
2+
java.awt
3+
java.awt.color
4+
java.awt.datatransfer
5+
java.awt.dnd
6+
java.awt.event
7+
java.awt.font
8+
java.awt.geom
9+
java.awt.im
10+
java.awt.im.spi
11+
java.awt.image
12+
java.awt.image.renderable
13+
java.awt.print
14+
java.beans
15+
java.beans.beancontext
16+
java.io
17+
java.lang
18+
java.lang.annotation
19+
java.lang.instrument
20+
java.lang.invoke
21+
java.lang.management
22+
java.lang.ref
23+
java.lang.reflect
24+
java.math
25+
java.net
26+
java.nio
27+
java.nio.channels
28+
java.nio.channels.spi
29+
java.nio.charset
30+
java.nio.charset.spi
31+
java.nio.file
32+
java.nio.file.attribute
33+
java.nio.file.spi
34+
java.rmi
35+
java.rmi.activation
36+
java.rmi.dgc
37+
java.rmi.registry
38+
java.rmi.server
39+
java.security
40+
java.security.acl
41+
java.security.cert
42+
java.security.interfaces
43+
java.security.spec
44+
java.sql
45+
java.text
46+
java.text.spi
47+
java.time
48+
java.time.chrono
49+
java.time.format
50+
java.time.temporal
51+
java.time.zone
52+
java.util
53+
java.util.concurrent
54+
java.util.concurrent.atomic
55+
java.util.concurrent.locks
56+
java.util.function
57+
java.util.jar
58+
java.util.logging
59+
java.util.prefs
60+
java.util.regex
61+
java.util.spi
62+
java.util.stream
63+
java.util.zip
64+
javax.accessibility
65+
javax.activation
66+
javax.activity
67+
javax.annotation
68+
javax.annotation.processing
69+
javax.crypto
70+
javax.crypto.interfaces
71+
javax.crypto.spec
72+
javax.imageio
73+
javax.imageio.event
74+
javax.imageio.metadata
75+
javax.imageio.plugins.bmp
76+
javax.imageio.plugins.jpeg
77+
javax.imageio.spi
78+
javax.imageio.stream
79+
javax.jws
80+
javax.jws.soap
81+
javax.lang.model
82+
javax.lang.model.element
83+
javax.lang.model.type
84+
javax.lang.model.util
85+
javax.management
86+
javax.management.loading
87+
javax.management.modelmbean
88+
javax.management.monitor
89+
javax.management.openmbean
90+
javax.management.relation
91+
javax.management.remote
92+
javax.management.remote.rmi
93+
javax.management.timer
94+
javax.naming
95+
javax.naming.directory
96+
javax.naming.event
97+
javax.naming.ldap
98+
javax.naming.spi
99+
javax.net
100+
javax.net.ssl
101+
javax.print
102+
javax.print.attribute
103+
javax.print.attribute.standard
104+
javax.print.event
105+
javax.rmi
106+
javax.rmi.CORBA
107+
javax.rmi.ssl
108+
javax.script
109+
javax.security.auth
110+
javax.security.auth.callback
111+
javax.security.auth.kerberos
112+
javax.security.auth.login
113+
javax.security.auth.spi
114+
javax.security.auth.x500
115+
javax.security.cert
116+
javax.security.sasl
117+
javax.sound.midi
118+
javax.sound.midi.spi
119+
javax.sound.sampled
120+
javax.sound.sampled.spi
121+
javax.sql
122+
javax.sql.rowset
123+
javax.sql.rowset.serial
124+
javax.sql.rowset.spi
125+
javax.swing
126+
javax.swing.border
127+
javax.swing.colorchooser
128+
javax.swing.event
129+
javax.swing.filechooser
130+
javax.swing.plaf
131+
javax.swing.plaf.basic
132+
javax.swing.plaf.metal
133+
javax.swing.plaf.multi
134+
javax.swing.plaf.nimbus
135+
javax.swing.plaf.synth
136+
javax.swing.table
137+
javax.swing.text
138+
javax.swing.text.html
139+
javax.swing.text.html.parser
140+
javax.swing.text.rtf
141+
javax.swing.tree
142+
javax.swing.undo
143+
javax.tools
144+
javax.transaction
145+
javax.transaction.xa
146+
javax.xml
147+
javax.xml.bind
148+
javax.xml.bind.annotation
149+
javax.xml.bind.annotation.adapters
150+
javax.xml.bind.attachment
151+
javax.xml.bind.helpers
152+
javax.xml.bind.util
153+
javax.xml.crypto
154+
javax.xml.crypto.dom
155+
javax.xml.crypto.dsig
156+
javax.xml.crypto.dsig.dom
157+
javax.xml.crypto.dsig.keyinfo
158+
javax.xml.crypto.dsig.spec
159+
javax.xml.datatype
160+
javax.xml.namespace
161+
javax.xml.parsers
162+
javax.xml.soap
163+
javax.xml.stream
164+
javax.xml.stream.events
165+
javax.xml.stream.util
166+
javax.xml.transform
167+
javax.xml.transform.dom
168+
javax.xml.transform.sax
169+
javax.xml.transform.stax
170+
javax.xml.transform.stream
171+
javax.xml.validation
172+
javax.xml.ws
173+
javax.xml.ws.handler
174+
javax.xml.ws.handler.soap
175+
javax.xml.ws.http
176+
javax.xml.ws.soap
177+
javax.xml.ws.spi
178+
javax.xml.ws.spi.http
179+
javax.xml.ws.wsaddressing
180+
javax.xml.xpath
181+
org.ietf.jgss
182+
org.omg.CORBA
183+
org.omg.CORBA.DynAnyPackage
184+
org.omg.CORBA.ORBPackage
185+
org.omg.CORBA.TypeCodePackage
186+
org.omg.CORBA.portable
187+
org.omg.CORBA_2_3
188+
org.omg.CORBA_2_3.portable
189+
org.omg.CosNaming
190+
org.omg.CosNaming.NamingContextExtPackage
191+
org.omg.CosNaming.NamingContextPackage
192+
org.omg.Dynamic
193+
org.omg.DynamicAny
194+
org.omg.DynamicAny.DynAnyFactoryPackage
195+
org.omg.DynamicAny.DynAnyPackage
196+
org.omg.IOP
197+
org.omg.IOP.CodecFactoryPackage
198+
org.omg.IOP.CodecPackage
199+
org.omg.Messaging
200+
org.omg.PortableInterceptor
201+
org.omg.PortableInterceptor.ORBInitInfoPackage
202+
org.omg.PortableServer
203+
org.omg.PortableServer.CurrentPackage
204+
org.omg.PortableServer.POAManagerPackage
205+
org.omg.PortableServer.POAPackage
206+
org.omg.PortableServer.ServantLocatorPackage
207+
org.omg.PortableServer.portable
208+
org.omg.SendingContext
209+
org.omg.stub.java.rmi
210+
org.w3c.dom
211+
org.w3c.dom.bootstrap
212+
org.w3c.dom.events
213+
org.w3c.dom.ls
214+
org.w3c.dom.views
215+
org.xml.sax
216+
org.xml.sax.ext
217+
org.xml.sax.helpers
Lines changed: 131 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
1+
<!DOCTYPE HTML>
2+
<html lang="en">
3+
<head>
4+
<!-- Generated by javadoc (17) on Thu Jul 31 17:41:15 UTC 2025 -->
5+
<title>All Classes and Interfaces (msal4j-persistence-extension 1.3.0 API)</title>
6+
<meta name="viewport" content="width=device-width, initial-scale=1">
7+
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8+
<meta name="dc.created" content="2025-07-31">
9+
<meta name="description" content="class index">
10+
<meta name="generator" content="javadoc/AllClassesIndexWriter">
11+
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
12+
<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style">
13+
<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
14+
<script type="text/javascript" src="script.js"></script>
15+
<script type="text/javascript" src="script-dir/jquery-3.7.1.min.js"></script>
16+
<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
17+
</head>
18+
<body class="all-classes-index-page">
19+
<script type="text/javascript">var evenRowColor = "even-row-color";
20+
var oddRowColor = "odd-row-color";
21+
var tableTab = "table-tab";
22+
var activeTableTab = "active-table-tab";
23+
var pathtoroot = "./";
24+
loadScripts(document, 'script');</script>
25+
<noscript>
26+
<div>JavaScript is disabled on your browser.</div>
27+
</noscript>
28+
<div class="flex-box">
29+
<header role="banner" class="flex-header">
30+
<nav role="navigation">
31+
<!-- ========= START OF TOP NAVBAR ======= -->
32+
<div class="top-nav" id="navbar-top">
33+
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
34+
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
35+
<li><a href="index.html">Overview</a></li>
36+
<li>Package</li>
37+
<li>Class</li>
38+
<li>Use</li>
39+
<li><a href="overview-tree.html">Tree</a></li>
40+
<li><a href="index-all.html">Index</a></li>
41+
<li><a href="help-doc.html#all-classes">Help</a></li>
42+
</ul>
43+
</div>
44+
<div class="sub-nav">
45+
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
46+
<input type="text" id="search-input" value="search" disabled="disabled">
47+
<input type="reset" id="reset-button" value="reset" disabled="disabled">
48+
</div>
49+
</div>
50+
<!-- ========= END OF TOP NAVBAR ========= -->
51+
<span class="skip-nav" id="skip-navbar-top"></span></nav>
52+
</header>
53+
<div class="flex-content">
54+
<main role="main">
55+
<div class="header">
56+
<h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces</h1>
57+
</div>
58+
<div id="all-classes-table">
59+
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="all-classes-table-tab0" role="tab" aria-selected="true" aria-controls="all-classes-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="all-classes-table-tab1" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab1', 2)" class="table-tab">Interfaces</button><button id="all-classes-table-tab2" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab2', 2)" class="table-tab">Classes</button><button id="all-classes-table-tab5" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab5', 2)" class="table-tab">Exceptions</button></div>
60+
<div id="all-classes-table.tabpanel" role="tabpanel" aria-labelledby="all-classes-table-tab0">
61+
<div class="summary-table two-column-summary">
62+
<div class="table-header col-first">Class</div>
63+
<div class="table-header col-last">Description</div>
64+
<div class="col-first even-row-color all-classes-table all-classes-table-tab5"><a href="com/microsoft/aad/msal4jextensions/persistence/CacheFileAccessException.html" title="class in com.microsoft.aad.msal4jextensions.persistence">CacheFileAccessException</a></div>
65+
<div class="col-last even-row-color all-classes-table all-classes-table-tab5">
66+
<div class="block">Runtime Exception representing error/failure to access Cache File</div>
67+
</div>
68+
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/microsoft/aad/msal4jextensions/persistence/CacheFileAccessor.html" title="class in com.microsoft.aad.msal4jextensions.persistence">CacheFileAccessor</a></div>
69+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
70+
<div class="block">Implementation of CacheAccessor based on File persistence</div>
71+
</div>
72+
<div class="col-first even-row-color all-classes-table all-classes-table-tab5"><a href="com/microsoft/aad/msal4jextensions/CacheFileLockAcquisitionException.html" title="class in com.microsoft.aad.msal4jextensions">CacheFileLockAcquisitionException</a></div>
73+
<div class="col-last even-row-color all-classes-table all-classes-table-tab5">
74+
<div class="block">Exception represents failure/error of acquiring cross process cacheFile lock</div>
75+
</div>
76+
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="com/microsoft/aad/msal4jextensions/persistence/ICacheAccessor.html" title="interface in com.microsoft.aad.msal4jextensions.persistence">ICacheAccessor</a></div>
77+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
78+
<div class="block">Interface for cache data access operations.</div>
79+
</div>
80+
<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="com/microsoft/aad/msal4jextensions/persistence/linux/ISecurityLibrary.html" title="interface in com.microsoft.aad.msal4jextensions.persistence.linux">ISecurityLibrary</a></div>
81+
<div class="col-last even-row-color all-classes-table all-classes-table-tab1">
82+
<div class="block">Interface which represents API for libsecret library on Linux.</div>
83+
</div>
84+
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="com/microsoft/aad/msal4jextensions/persistence/mac/ISecurityLibrary.html" title="interface in com.microsoft.aad.msal4jextensions.persistence.mac">ISecurityLibrary</a></div>
85+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
86+
<div class="block">Interface which represents API for accessing KeyChain on Mac.</div>
87+
</div>
88+
<div class="col-first even-row-color all-classes-table all-classes-table-tab5"><a href="com/microsoft/aad/msal4jextensions/persistence/mac/KeyChainAccessException.html" title="class in com.microsoft.aad.msal4jextensions.persistence.mac">KeyChainAccessException</a></div>
89+
<div class="col-last even-row-color all-classes-table all-classes-table-tab5">
90+
<div class="block">Runtime Exception representing error/failure to access KeyChain on Mac</div>
91+
</div>
92+
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/microsoft/aad/msal4jextensions/persistence/mac/KeyChainAccessor.html" title="class in com.microsoft.aad.msal4jextensions.persistence.mac">KeyChainAccessor</a></div>
93+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
94+
<div class="block">Implementation of CacheAccessor based on KeyChain for Mac</div>
95+
</div>
96+
<div class="col-first even-row-color all-classes-table all-classes-table-tab5"><a href="com/microsoft/aad/msal4jextensions/persistence/linux/KeyRingAccessException.html" title="class in com.microsoft.aad.msal4jextensions.persistence.linux">KeyRingAccessException</a></div>
97+
<div class="col-last even-row-color all-classes-table all-classes-table-tab5">
98+
<div class="block">Runtime Exception representing error/failure to access KeyRing on Linux</div>
99+
</div>
100+
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/microsoft/aad/msal4jextensions/persistence/linux/KeyRingAccessor.html" title="class in com.microsoft.aad.msal4jextensions.persistence.linux">KeyRingAccessor</a></div>
101+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
102+
<div class="block">Implementation of CacheAccessor based on KeyRing for Linux</div>
103+
</div>
104+
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/microsoft/aad/msal4jextensions/PersistenceSettings.html" title="class in com.microsoft.aad.msal4jextensions">PersistenceSettings</a></div>
105+
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
106+
<div class="block">An immutable class containing persistence settings for MSAL caches in various platforms.</div>
107+
</div>
108+
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/microsoft/aad/msal4jextensions/PersistenceSettings.Builder.html" title="class in com.microsoft.aad.msal4jextensions">PersistenceSettings.Builder</a></div>
109+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
110+
<div class="block">An builder for <a href="com/microsoft/aad/msal4jextensions/PersistenceSettings.html" title="class in com.microsoft.aad.msal4jextensions"><code>PersistenceSettings</code></a> objects.</div>
111+
</div>
112+
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/microsoft/aad/msal4jextensions/PersistenceTokenCacheAccessAspect.html" title="class in com.microsoft.aad.msal4jextensions">PersistenceTokenCacheAccessAspect</a></div>
113+
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
114+
<div class="block">Implementation of ITokenCacheAccessAspect which store MSAL token cache
115+
in platform specific secret storage:
116+
Win - file encrypted with DPAPI
117+
Mac - key chain
118+
Linux - key ring</div>
119+
</div>
120+
</div>
121+
</div>
122+
</div>
123+
</main>
124+
<footer role="contentinfo">
125+
<hr>
126+
<p class="legal-copy"><small>Copyright &#169; 2025. All rights reserved.</small></p>
127+
</footer>
128+
</div>
129+
</div>
130+
</body>
131+
</html>

0 commit comments

Comments
 (0)