#188 APIリファレンスに反映。

AkiraNetwork · Sep 2, 2024 · 7a88f4b · 7a88f4b
1 parent 2d5b48a
commit 7a88f4b
Show file tree

Hide file tree

Showing 37 changed files with 501 additions and 362 deletions.
diff --git a/docs/api/AkiraNetwork.VirtualStorageLibrary.VirtualStorage-1.html b/docs/api/AkiraNetwork.VirtualStorageLibrary.VirtualStorage-1.html
@@ -1852,6 +1852,34 @@ <h5 class="returns">Returns</h5>
       <tr>
         <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
         <td><p>True if the node exists; otherwise, false.</p>
+</td>
+      </tr>
+    </tbody>
+  </table>
+  <a id="AkiraNetwork_VirtualStorageLibrary_VirtualStorage_1_RefreshLinkDictionary_" data-uid="AkiraNetwork.VirtualStorageLibrary.VirtualStorage`1.RefreshLinkDictionary*"></a>
+  <h4 id="AkiraNetwork_VirtualStorageLibrary_VirtualStorage_1_RefreshLinkDictionary_AkiraNetwork_VirtualStorageLibrary_VirtualPath_" data-uid="AkiraNetwork.VirtualStorageLibrary.VirtualStorage`1.RefreshLinkDictionary(AkiraNetwork.VirtualStorageLibrary.VirtualPath)">RefreshLinkDictionary(VirtualPath)</h4>
+  <div class="markdown level1 summary"><p>Refreshes the link dictionary by updating the target path of the symbolic link at the specified path.
+If the link is not found in the dictionary, it will be added and the TargetNodeType will be set.</p>
+</div>
+  <div class="markdown level1 conceptual"></div>
+  <h5 class="declaration">Declaration</h5>
+  <div class="codewrapper">
+    <pre><code class="lang-csharp hljs">public void RefreshLinkDictionary(VirtualPath linkPath)</code></pre>
+  </div>
+  <h5 class="parameters">Parameters</h5>
+  <table class="table table-bordered table-condensed">
+    <thead>
+      <tr>
+        <th>Type</th>
+        <th>Name</th>
+        <th>Description</th>
+      </tr>
+    </thead>
+    <tbody>
+      <tr>
+        <td><a class="xref" href="AkiraNetwork.VirtualStorageLibrary.VirtualPath.html">VirtualPath</a></td>
+        <td><span class="parametername">linkPath</span></td>
+        <td><p>The path of the symbolic link to be used for updating the link dictionary.</p>
 </td>
       </tr>
     </tbody>

diff --git a/docs/api/AkiraNetwork.VirtualStorageLibrary.VirtualSymbolicLink.html b/docs/api/AkiraNetwork.VirtualStorageLibrary.VirtualSymbolicLink.html
@@ -475,6 +475,24 @@ <h5 class="parameters">Parameters</h5>
   </table>
   <h5 class="overrides">Overrides</h5>
   <div><a class="xref" href="AkiraNetwork.VirtualStorageLibrary.VirtualNode.html#AkiraNetwork_VirtualStorageLibrary_VirtualNode_Update_AkiraNetwork_VirtualStorageLibrary_VirtualNode_">VirtualNode.Update(VirtualNode)</a></div>
+  <h5 id="AkiraNetwork_VirtualStorageLibrary_VirtualSymbolicLink_Update_AkiraNetwork_VirtualStorageLibrary_VirtualNode__remarks">Remarks</h5>
+  <div class="markdown level1 remarks"><p>After updating an instance of VirtualSymbolicLink that has been added to VirtualStorage,
+call the RefreshLinkDictionary method of the VirtualStorage class to update the link dictionary.
+However, this is not necessary if the symbolic link is updated using the SetNode method of the VirtualStorage class.</p>
+<pre><code class="lang-csharp">VirtualStorage&lt;UserType&gt; vs = new();
+
+vs.AddDirectory("/dir1");
+vs.AddItem("/dir1/item1");
+vs.AddDirectory("/dir2");
+vs.AddItem("/dir2/item1");
+vs.AddSymbolicLink("/link1", "/dir1/item1");
+
+VirtualSymbolicLink link = vs.GetSymbolicLink("/link1");
+VirtualSymbolicLink newLink = new("/link1", "/dir2/item1");
+
+link.Update(newLink);
+vs.RefreshLinkDictionary("/link1");</code></pre>
+</div>
   <h5 class="exceptions">Exceptions</h5>
   <table class="table table-bordered table-condensed">
     <thead>

diff --git a/docs/index.json b/docs/index.json
diff --git a/docs/xrefmap.yml b/docs/xrefmap.yml
@@ -4475,6 +4475,23 @@ references:
   fullName.vb: AkiraNetwork.VirtualStorageLibrary.VirtualStorage(Of T).NodeExists
   nameWithType: VirtualStorage<T>.NodeExists
   nameWithType.vb: VirtualStorage(Of T).NodeExists
+- uid: AkiraNetwork.VirtualStorageLibrary.VirtualStorage`1.RefreshLinkDictionary(AkiraNetwork.VirtualStorageLibrary.VirtualPath)
+  name: RefreshLinkDictionary(VirtualPath)
+  href: api/AkiraNetwork.VirtualStorageLibrary.VirtualStorage-1.html#AkiraNetwork_VirtualStorageLibrary_VirtualStorage_1_RefreshLinkDictionary_AkiraNetwork_VirtualStorageLibrary_VirtualPath_
+  commentId: M:AkiraNetwork.VirtualStorageLibrary.VirtualStorage`1.RefreshLinkDictionary(AkiraNetwork.VirtualStorageLibrary.VirtualPath)
+  fullName: AkiraNetwork.VirtualStorageLibrary.VirtualStorage<T>.RefreshLinkDictionary(AkiraNetwork.VirtualStorageLibrary.VirtualPath)
+  fullName.vb: AkiraNetwork.VirtualStorageLibrary.VirtualStorage(Of T).RefreshLinkDictionary(AkiraNetwork.VirtualStorageLibrary.VirtualPath)
+  nameWithType: VirtualStorage<T>.RefreshLinkDictionary(VirtualPath)
+  nameWithType.vb: VirtualStorage(Of T).RefreshLinkDictionary(VirtualPath)
+- uid: AkiraNetwork.VirtualStorageLibrary.VirtualStorage`1.RefreshLinkDictionary*
+  name: RefreshLinkDictionary
+  href: api/AkiraNetwork.VirtualStorageLibrary.VirtualStorage-1.html#AkiraNetwork_VirtualStorageLibrary_VirtualStorage_1_RefreshLinkDictionary_
+  commentId: Overload:AkiraNetwork.VirtualStorageLibrary.VirtualStorage`1.RefreshLinkDictionary
+  isSpec: "True"
+  fullName: AkiraNetwork.VirtualStorageLibrary.VirtualStorage<T>.RefreshLinkDictionary
+  fullName.vb: AkiraNetwork.VirtualStorageLibrary.VirtualStorage(Of T).RefreshLinkDictionary
+  nameWithType: VirtualStorage<T>.RefreshLinkDictionary
+  nameWithType.vb: VirtualStorage(Of T).RefreshLinkDictionary
 - uid: AkiraNetwork.VirtualStorageLibrary.VirtualStorage`1.RemoveLinkByLinkPath(AkiraNetwork.VirtualStorageLibrary.VirtualPath)
   name: RemoveLinkByLinkPath(VirtualPath)
   href: api/AkiraNetwork.VirtualStorageLibrary.VirtualStorage-1.html#AkiraNetwork_VirtualStorageLibrary_VirtualStorage_1_RemoveLinkByLinkPath_AkiraNetwork_VirtualStorageLibrary_VirtualPath_

diff --git a/documents/api/.manifest b/documents/api/.manifest
@@ -296,6 +296,7 @@
   "AkiraNetwork.VirtualStorageLibrary.VirtualStorage`1.LinkDictionary": "AkiraNetwork.VirtualStorageLibrary.VirtualStorage-1.yml",
   "AkiraNetwork.VirtualStorageLibrary.VirtualStorage`1.MoveNode(AkiraNetwork.VirtualStorageLibrary.VirtualPath,AkiraNetwork.VirtualStorageLibrary.VirtualPath,System.Boolean,System.Boolean)": "AkiraNetwork.VirtualStorageLibrary.VirtualStorage-1.yml",
   "AkiraNetwork.VirtualStorageLibrary.VirtualStorage`1.NodeExists(AkiraNetwork.VirtualStorageLibrary.VirtualPath,System.Boolean)": "AkiraNetwork.VirtualStorageLibrary.VirtualStorage-1.yml",
+  "AkiraNetwork.VirtualStorageLibrary.VirtualStorage`1.RefreshLinkDictionary(AkiraNetwork.VirtualStorageLibrary.VirtualPath)": "AkiraNetwork.VirtualStorageLibrary.VirtualStorage-1.yml",
   "AkiraNetwork.VirtualStorageLibrary.VirtualStorage`1.RemoveLinkByLinkPath(AkiraNetwork.VirtualStorageLibrary.VirtualPath)": "AkiraNetwork.VirtualStorageLibrary.VirtualStorage-1.yml",
   "AkiraNetwork.VirtualStorageLibrary.VirtualStorage`1.RemoveLinkFromDictionary(AkiraNetwork.VirtualStorageLibrary.VirtualPath,AkiraNetwork.VirtualStorageLibrary.VirtualPath)": "AkiraNetwork.VirtualStorageLibrary.VirtualStorage-1.yml",
   "AkiraNetwork.VirtualStorageLibrary.VirtualStorage`1.RemoveNode(AkiraNetwork.VirtualStorageLibrary.VirtualPath,System.Boolean,System.Boolean,System.Boolean)": "AkiraNetwork.VirtualStorageLibrary.VirtualStorage-1.yml",

diff --git a/documents/api/AkiraNetwork.VirtualStorageLibrary.ActionNodeDelegate.yml b/documents/api/AkiraNetwork.VirtualStorageLibrary.ActionNodeDelegate.yml
@@ -15,7 +15,7 @@ items:
   source:
     remote:
       path: AkiraNetwork/VirtualStorageLibrary/VirtualDelegates.cs
-      branch: master
+      branch: bugfix/issue-188-check-link-dictionary-when-add-symboliclink
       repo: https://github.com/shimodateakira/VirtualStorageLibrary
     id: ActionNodeDelegate
     path: ../AkiraNetwork/VirtualStorageLibrary/VirtualDelegates.cs

diff --git a/documents/api/AkiraNetwork.VirtualStorageLibrary.IVirtualDeepCloneable-1.yml b/documents/api/AkiraNetwork.VirtualStorageLibrary.IVirtualDeepCloneable-1.yml
@@ -16,7 +16,7 @@ items:
   source:
     remote:
       path: AkiraNetwork/VirtualStorageLibrary/VirtualInterfaces.cs
-      branch: master
+      branch: bugfix/issue-188-check-link-dictionary-when-add-symboliclink
       repo: https://github.com/shimodateakira/VirtualStorageLibrary
     id: IVirtualDeepCloneable
     path: ../AkiraNetwork/VirtualStorageLibrary/VirtualInterfaces.cs
@@ -51,7 +51,7 @@ items:
   source:
     remote:
       path: AkiraNetwork/VirtualStorageLibrary/VirtualInterfaces.cs
-      branch: master
+      branch: bugfix/issue-188-check-link-dictionary-when-add-symboliclink
       repo: https://github.com/shimodateakira/VirtualStorageLibrary
     id: DeepClone
     path: ../AkiraNetwork/VirtualStorageLibrary/VirtualInterfaces.cs

diff --git a/documents/api/AkiraNetwork.VirtualStorageLibrary.IVirtualWildcardMatcher.yml b/documents/api/AkiraNetwork.VirtualStorageLibrary.IVirtualWildcardMatcher.yml
@@ -21,7 +21,7 @@ items:
   source:
     remote:
       path: AkiraNetwork/VirtualStorageLibrary/VirtualInterfaces.cs
-      branch: master
+      branch: bugfix/issue-188-check-link-dictionary-when-add-symboliclink
       repo: https://github.com/shimodateakira/VirtualStorageLibrary
     id: IVirtualWildcardMatcher
     path: ../AkiraNetwork/VirtualStorageLibrary/VirtualInterfaces.cs
@@ -50,7 +50,7 @@ items:
   source:
     remote:
       path: AkiraNetwork/VirtualStorageLibrary/VirtualInterfaces.cs
-      branch: master
+      branch: bugfix/issue-188-check-link-dictionary-when-add-symboliclink
       repo: https://github.com/shimodateakira/VirtualStorageLibrary
     id: WildcardDictionary
     path: ../AkiraNetwork/VirtualStorageLibrary/VirtualInterfaces.cs
@@ -85,7 +85,7 @@ items:
   source:
     remote:
       path: AkiraNetwork/VirtualStorageLibrary/VirtualInterfaces.cs
-      branch: master
+      branch: bugfix/issue-188-check-link-dictionary-when-add-symboliclink
       repo: https://github.com/shimodateakira/VirtualStorageLibrary
     id: Wildcards
     path: ../AkiraNetwork/VirtualStorageLibrary/VirtualInterfaces.cs
@@ -117,7 +117,7 @@ items:
   source:
     remote:
       path: AkiraNetwork/VirtualStorageLibrary/VirtualInterfaces.cs
-      branch: master
+      branch: bugfix/issue-188-check-link-dictionary-when-add-symboliclink
       repo: https://github.com/shimodateakira/VirtualStorageLibrary
     id: Patterns
     path: ../AkiraNetwork/VirtualStorageLibrary/VirtualInterfaces.cs
@@ -149,7 +149,7 @@ items:
   source:
     remote:
       path: AkiraNetwork/VirtualStorageLibrary/VirtualInterfaces.cs
-      branch: master
+      branch: bugfix/issue-188-check-link-dictionary-when-add-symboliclink
       repo: https://github.com/shimodateakira/VirtualStorageLibrary
     id: Count
     path: ../AkiraNetwork/VirtualStorageLibrary/VirtualInterfaces.cs
@@ -181,7 +181,7 @@ items:
   source:
     remote:
       path: AkiraNetwork/VirtualStorageLibrary/VirtualInterfaces.cs
-      branch: master
+      branch: bugfix/issue-188-check-link-dictionary-when-add-symboliclink
       repo: https://github.com/shimodateakira/VirtualStorageLibrary
     id: PatternMatcher
     path: ../AkiraNetwork/VirtualStorageLibrary/VirtualInterfaces.cs
@@ -222,7 +222,7 @@ items:
   source:
     remote:
       path: AkiraNetwork/VirtualStorageLibrary/VirtualInterfaces.cs
-      branch: master
+      branch: bugfix/issue-188-check-link-dictionary-when-add-symboliclink
       repo: https://github.com/shimodateakira/VirtualStorageLibrary
     id: IsValidWildcardPattern
     path: ../AkiraNetwork/VirtualStorageLibrary/VirtualInterfaces.cs

diff --git a/documents/api/AkiraNetwork.VirtualStorageLibrary.NotifyNodeDelegate.yml b/documents/api/AkiraNetwork.VirtualStorageLibrary.NotifyNodeDelegate.yml
@@ -15,7 +15,7 @@ items:
   source:
     remote:
       path: AkiraNetwork/VirtualStorageLibrary/VirtualDelegates.cs
-      branch: master
+      branch: bugfix/issue-188-check-link-dictionary-when-add-symboliclink
       repo: https://github.com/shimodateakira/VirtualStorageLibrary
     id: NotifyNodeDelegate
     path: ../AkiraNetwork/VirtualStorageLibrary/VirtualDelegates.cs

diff --git a/documents/api/AkiraNetwork.VirtualStorageLibrary.PatternMatch.yml b/documents/api/AkiraNetwork.VirtualStorageLibrary.PatternMatch.yml
@@ -15,7 +15,7 @@ items:
   source:
     remote:
       path: AkiraNetwork/VirtualStorageLibrary/VirtualDelegates.cs
-      branch: master
+      branch: bugfix/issue-188-check-link-dictionary-when-add-symboliclink
       repo: https://github.com/shimodateakira/VirtualStorageLibrary
     id: PatternMatch
     path: ../AkiraNetwork/VirtualStorageLibrary/VirtualDelegates.cs

diff --git a/documents/api/AkiraNetwork.VirtualStorageLibrary.Utilities.VirtualTextFormatter.yml b/documents/api/AkiraNetwork.VirtualStorageLibrary.Utilities.VirtualTextFormatter.yml
@@ -19,7 +19,7 @@ items:
   source:
     remote:
       path: AkiraNetwork/VirtualStorageLibrary/Utilities/VirtualTextFormatter.cs
-      branch: master
+      branch: bugfix/issue-188-check-link-dictionary-when-add-symboliclink
       repo: https://github.com/shimodateakira/VirtualStorageLibrary
     id: VirtualTextFormatter
     path: ../AkiraNetwork/VirtualStorageLibrary/Utilities/VirtualTextFormatter.cs
@@ -91,7 +91,7 @@ items:
   source:
     remote:
       path: AkiraNetwork/VirtualStorageLibrary/Utilities/VirtualTextFormatter.cs
-      branch: master
+      branch: bugfix/issue-188-check-link-dictionary-when-add-symboliclink
       repo: https://github.com/shimodateakira/VirtualStorageLibrary
     id: GenerateTreeDebugText
     path: ../AkiraNetwork/VirtualStorageLibrary/Utilities/VirtualTextFormatter.cs
@@ -184,7 +184,7 @@ items:
   source:
     remote:
       path: AkiraNetwork/VirtualStorageLibrary/Utilities/VirtualTextFormatter.cs
-      branch: master
+      branch: bugfix/issue-188-check-link-dictionary-when-add-symboliclink
       repo: https://github.com/shimodateakira/VirtualStorageLibrary
     id: GenerateLinkTableDebugText
     path: ../AkiraNetwork/VirtualStorageLibrary/Utilities/VirtualTextFormatter.cs
@@ -226,7 +226,7 @@ items:
   source:
     remote:
       path: AkiraNetwork/VirtualStorageLibrary/Utilities/VirtualTextFormatter.cs
-      branch: master
+      branch: bugfix/issue-188-check-link-dictionary-when-add-symboliclink
       repo: https://github.com/shimodateakira/VirtualStorageLibrary
     id: GenerateTableDebugText
     path: ../AkiraNetwork/VirtualStorageLibrary/Utilities/VirtualTextFormatter.cs
@@ -268,7 +268,7 @@ items:
   source:
     remote:
       path: AkiraNetwork/VirtualStorageLibrary/Utilities/VirtualTextFormatter.cs
-      branch: master
+      branch: bugfix/issue-188-check-link-dictionary-when-add-symboliclink
       repo: https://github.com/shimodateakira/VirtualStorageLibrary
     id: GenerateSingleTableDebugText
     path: ../AkiraNetwork/VirtualStorageLibrary/Utilities/VirtualTextFormatter.cs

diff --git a/documents/api/AkiraNetwork.VirtualStorageLibrary.VirtualCycleDetector.yml b/documents/api/AkiraNetwork.VirtualStorageLibrary.VirtualCycleDetector.yml
@@ -20,7 +20,7 @@ items:
   source:
     remote:
       path: AkiraNetwork/VirtualStorageLibrary/VirtualCycleDetector.cs
-      branch: master
+      branch: bugfix/issue-188-check-link-dictionary-when-add-symboliclink
       repo: https://github.com/shimodateakira/VirtualStorageLibrary
     id: VirtualCycleDetector
     path: ../AkiraNetwork/VirtualStorageLibrary/VirtualCycleDetector.cs
@@ -62,7 +62,7 @@ items:
   source:
     remote:
       path: AkiraNetwork/VirtualStorageLibrary/VirtualCycleDetector.cs
-      branch: master
+      branch: bugfix/issue-188-check-link-dictionary-when-add-symboliclink
       repo: https://github.com/shimodateakira/VirtualStorageLibrary
     id: CycleDictionary
     path: ../AkiraNetwork/VirtualStorageLibrary/VirtualCycleDetector.cs
@@ -97,7 +97,7 @@ items:
   source:
     remote:
       path: AkiraNetwork/VirtualStorageLibrary/VirtualCycleDetector.cs
-      branch: master
+      branch: bugfix/issue-188-check-link-dictionary-when-add-symboliclink
       repo: https://github.com/shimodateakira/VirtualStorageLibrary
     id: Count
     path: ../AkiraNetwork/VirtualStorageLibrary/VirtualCycleDetector.cs
@@ -129,7 +129,7 @@ items:
   source:
     remote:
       path: AkiraNetwork/VirtualStorageLibrary/VirtualCycleDetector.cs
-      branch: master
+      branch: bugfix/issue-188-check-link-dictionary-when-add-symboliclink
       repo: https://github.com/shimodateakira/VirtualStorageLibrary
     id: .ctor
     path: ../AkiraNetwork/VirtualStorageLibrary/VirtualCycleDetector.cs
@@ -160,7 +160,7 @@ items:
   source:
     remote:
       path: AkiraNetwork/VirtualStorageLibrary/VirtualCycleDetector.cs
-      branch: master
+      branch: bugfix/issue-188-check-link-dictionary-when-add-symboliclink
       repo: https://github.com/shimodateakira/VirtualStorageLibrary
     id: Clear
     path: ../AkiraNetwork/VirtualStorageLibrary/VirtualCycleDetector.cs
@@ -188,7 +188,7 @@ items:
   source:
     remote:
       path: AkiraNetwork/VirtualStorageLibrary/VirtualCycleDetector.cs
-      branch: master
+      branch: bugfix/issue-188-check-link-dictionary-when-add-symboliclink
       repo: https://github.com/shimodateakira/VirtualStorageLibrary
     id: IsNodeInCycle
     path: ../AkiraNetwork/VirtualStorageLibrary/VirtualCycleDetector.cs