pull/27/head
Simon G 5 years ago
parent 3f891b45c9
commit 7b97b75fb6
  1. 291
      GBase/GBase.xml

@ -87,13 +87,15 @@
<param name="value">The value to set</param> <param name="value">The value to set</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> to await</returns> <returns>A <see cref="T:System.Threading.Tasks.Task"/> to await</returns>
</member> </member>
<member name="M:GBase.DataHandling.Cache.XmlDataHandlerCache.TryGetValues``2(System.String)"> <member name="M:GBase.DataHandling.Cache.XmlDataHandlerCache.TryGetValues``2(System.IO.FileStream,System.String,System.Threading.CancellationToken)">
<summary> <summary>
Try to get values from the cache for the given property Try to get values from the cache for the given property
</summary> </summary>
<typeparam name="T">The <see cref="T:System.Type"/> that implements the property</typeparam> <typeparam name="T">The <see cref="T:System.Type"/> that implements the property</typeparam>
<typeparam name="TProperty">The <see cref="T:System.Type"/> of the property</typeparam> <typeparam name="TProperty">The <see cref="T:System.Type"/> of the property</typeparam>
<param name="file"></param>
<param name="propertyName">The name of the property</param> <param name="propertyName">The name of the property</param>
<param name="cancellationToken"></param>
<returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> with all the values for the property</returns> <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> with all the values for the property</returns>
</member> </member>
<member name="T:GBase.DataHandling.Cache.XmlDataHandlerCacheEntry"> <member name="T:GBase.DataHandling.Cache.XmlDataHandlerCacheEntry">
@ -163,11 +165,10 @@
Factory for the <see cref="T:GBase.Interfaces.DataHandling.Xml.IXmlDataReader"/> Factory for the <see cref="T:GBase.Interfaces.DataHandling.Xml.IXmlDataReader"/>
</summary> </summary>
</member> </member>
<member name="M:GBase.DataHandling.Factories.IXmlDataReaderFactory.Create(System.String)"> <member name="M:GBase.DataHandling.Factories.IXmlDataReaderFactory.Create">
<summary> <summary>
Creates an <see cref="T:GBase.Interfaces.DataHandling.Xml.IXmlDataReader"/> Creates an <see cref="T:GBase.Interfaces.DataHandling.Xml.IXmlDataReader"/>
</summary> </summary>
<param name="path">The path to the xml file</param>
<returns>A newly created instance of the implementation for <see cref="T:GBase.Interfaces.DataHandling.Xml.IXmlDataReader"/></returns> <returns>A newly created instance of the implementation for <see cref="T:GBase.Interfaces.DataHandling.Xml.IXmlDataReader"/></returns>
</member> </member>
<member name="T:GBase.DataHandling.Factories.IXmlDataWriterFactory"> <member name="T:GBase.DataHandling.Factories.IXmlDataWriterFactory">
@ -175,12 +176,10 @@
Factory for the <see cref="T:GBase.Interfaces.DataHandling.Xml.IXmlDataWriter"/> Factory for the <see cref="T:GBase.Interfaces.DataHandling.Xml.IXmlDataWriter"/>
</summary> </summary>
</member> </member>
<member name="M:GBase.DataHandling.Factories.IXmlDataWriterFactory.Create(System.String,System.String)"> <member name="M:GBase.DataHandling.Factories.IXmlDataWriterFactory.Create">
<summary> <summary>
Creates an <see cref="T:GBase.Interfaces.DataHandling.Xml.IXmlDataWriter"/> Creates an <see cref="T:GBase.Interfaces.DataHandling.Xml.IXmlDataWriter"/>
</summary> </summary>
<param name="path">The path to the xml file</param>
<param name="rootElementName">The root element name of the xml file</param>
<returns>A newly created instance of the implementation for <see cref="T:GBase.Interfaces.DataHandling.Xml.IXmlDataWriter"/></returns> <returns>A newly created instance of the implementation for <see cref="T:GBase.Interfaces.DataHandling.Xml.IXmlDataWriter"/></returns>
</member> </member>
<member name="T:GBase.DataHandling.XmlDataHandler"> <member name="T:GBase.DataHandling.XmlDataHandler">
@ -198,152 +197,142 @@
The attribute name of the value <see cref="T:System.Type"/> attribute The attribute name of the value <see cref="T:System.Type"/> attribute
</summary> </summary>
</member> </member>
<member name="M:GBase.DataHandling.XmlDataHandler.#ctor(System.String,System.String,GBase.DataHandling.Factories.IXmlDataReaderFactory,GBase.DataHandling.Factories.IXmlDataWriterFactory,GBase.DataHandling.Cache.Factories.IXmlDataHandlerCacheFactory)"> <member name="M:GBase.DataHandling.XmlDataHandler.#ctor(GBase.DataHandling.Factories.IXmlDataReaderFactory,GBase.DataHandling.Factories.IXmlDataWriterFactory,GBase.DataHandling.Cache.Factories.IXmlDataHandlerCacheFactory)">
<summary> <summary>
A <see cref="T:GBase.Interfaces.DataHandling.IDataHandler"/> that handles its data in an xml file A <see cref="T:GBase.Interfaces.DataHandling.IDataHandler"/> that handles its data in an xml file
</summary> </summary>
<param name="path">The path to the xml file</param> <param name="path">The path to the xml file</param>
<param name="rootElementName">The root element name of the xml file</param>
<param name="xmlDataReaderFactory">The <see cref="T:GBase.Interfaces.DataHandling.Xml.IXmlDataReader"/> factory</param> <param name="xmlDataReaderFactory">The <see cref="T:GBase.Interfaces.DataHandling.Xml.IXmlDataReader"/> factory</param>
<param name="xmlDataWriterFactory">The <see cref="T:GBase.Interfaces.DataHandling.Xml.IXmlDataWriter"/> factory</param> <param name="xmlDataWriterFactory">The <see cref="T:GBase.Interfaces.DataHandling.Xml.IXmlDataWriter"/> factory</param>
<param name="xmlDataHandlerCacheFactory">The <see cref="T:GBase.Interfaces.DataHandling.Xml.Cache.IXmlDataHandlerCache"/> factory</param> <param name="xmlDataHandlerCacheFactory">The <see cref="T:GBase.Interfaces.DataHandling.Xml.Cache.IXmlDataHandlerCache"/> factory</param>
</member> </member>
<member name="M:GBase.DataHandling.XmlDataHandler.Init(System.Boolean,System.Threading.CancellationToken)"> <member name="M:GBase.DataHandling.XmlDataHandler.Init(System.Boolean)">
<summary> <summary>
Initialize the <see cref="T:GBase.DataHandling.XmlDataHandler"/> Initialize the <see cref="T:GBase.DataHandling.XmlDataHandler"/>
</summary> </summary>
<param name="overwrite">If true an existing value is overwritten, if false an additional value is added</param> <param name="overwrite">If true an existing value is overwritten, if false an additional value is added</param>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken"/> to cancel the async operation</param>
<returns>Returns true if successful, false if not</returns> <returns>Returns true if successful, false if not</returns>
</member> </member>
<member name="M:GBase.DataHandling.XmlDataHandler.SetValue``2(System.String,``1)"> <member name="M:GBase.DataHandling.XmlDataHandler.SetValue``2(System.IO.FileStream,System.String,``1,System.Threading.CancellationToken)">
<summary> <summary>
Set the value for the given property Set the value for the given property
</summary> </summary>
<typeparam name="T">The <see cref="T:System.Type"/> that implements the property</typeparam> <typeparam name="T">The <see cref="T:System.Type"/> that implements the property</typeparam>
<typeparam name="TProperty">The <see cref="T:System.Type"/> of the property</typeparam> <typeparam name="TProperty">The <see cref="T:System.Type"/> of the property</typeparam>
<param name="entryFile"></param>
<param name="propertyName">The name of the property</param> <param name="propertyName">The name of the property</param>
<param name="value">The value to set</param> <param name="value">The value to set</param>
<param name="cancellationToken"></param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> to await</returns> <returns>A <see cref="T:System.Threading.Tasks.Task"/> to await</returns>
</member> </member>
<member name="M:GBase.DataHandling.XmlDataHandler.RemoveValue``2(System.String,``1)"> <member name="M:GBase.DataHandling.XmlDataHandler.RemoveValue``2(System.IO.FileStream,System.String,``1,System.Threading.CancellationToken)">
<summary> <summary>
Remove the value for the given property Remove the value for the given property
</summary> </summary>
<typeparam name="T">The <see cref="T:System.Type"/> of the property</typeparam> <typeparam name="T">The <see cref="T:System.Type"/> of the property</typeparam>
<typeparam name="TProperty">The <see cref="T:System.Type"/> of the property</typeparam> <typeparam name="TProperty">The <see cref="T:System.Type"/> of the property</typeparam>
<param name="entryFile"></param>
<param name="propertyName">The name of the property</param> <param name="propertyName">The name of the property</param>
<param name="value">The value to set</param> <param name="value">The value to set</param>
<param name="cancellationToken"></param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> to await</returns> <returns>A <see cref="T:System.Threading.Tasks.Task"/> to await</returns>
</member> </member>
<member name="M:GBase.DataHandling.XmlDataHandler.GetValue``2(System.String)"> <member name="M:GBase.DataHandling.XmlDataHandler.GetValue``2(System.IO.FileStream,System.String,System.Threading.CancellationToken)">
<summary> <summary>
Get the value for the given property, if multiple values are set the first is returned Get the value for the given property, if multiple values are set the first is returned
</summary> </summary>
<typeparam name="T">The <see cref="T:System.Type"/> that implements the property</typeparam> <typeparam name="T">The <see cref="T:System.Type"/> that implements the property</typeparam>
<typeparam name="TProperty">The <see cref="T:System.Type"/> of the property</typeparam> <typeparam name="TProperty">The <see cref="T:System.Type"/> of the property</typeparam>
<param name="file"></param>
<param name="propertyName">The name of the property</param> <param name="propertyName">The name of the property</param>
<param name="cancellationToken"></param>
<returns>The value for the given property</returns> <returns>The value for the given property</returns>
</member> </member>
<member name="M:GBase.DataHandling.XmlDataHandler.GetValues``2(System.String)"> <member name="M:GBase.DataHandling.XmlDataHandler.GetValues``2(System.IO.FileStream,System.String,System.Threading.CancellationToken)">
<summary> <summary>
Get all the values that are set for the given property Get all the values that are set for the given property
</summary> </summary>
<typeparam name="T">The <see cref="T:System.Type"/> that implements the property</typeparam> <typeparam name="T">The <see cref="T:System.Type"/> that implements the property</typeparam>
<typeparam name="TProperty">The <see cref="T:System.Type"/> of the property</typeparam> <typeparam name="TProperty">The <see cref="T:System.Type"/> of the property</typeparam>
<param name="file"></param>
<param name="propertyName">The name of the property</param> <param name="propertyName">The name of the property</param>
<param name="cancellationToken"></param>
<returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> with all the values for the property</returns> <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> with all the values for the property</returns>
</member> </member>
<member name="M:GBase.DataHandling.XmlDataHandler.DisposeAsync">
<summary>
Dispose used resources asynchronously
</summary>
<returns>A <see cref="T:System.Threading.Tasks.ValueTask"/> to await</returns>
</member>
<member name="T:GBase.DataHandling.XmlDataReader"> <member name="T:GBase.DataHandling.XmlDataReader">
<summary> <summary>
A <see cref="T:GBase.Interfaces.DataHandling.IDataReader"/> that reads from a xml file A <see cref="T:GBase.Interfaces.DataHandling.IDataReader"/> that reads from a xml file
</summary> </summary>
</member> </member>
<member name="M:GBase.DataHandling.XmlDataReader.#ctor(System.String)"> <member name="M:GBase.DataHandling.XmlDataReader.Read``2(System.IO.FileStream,System.String,System.Threading.CancellationToken)">
<summary>
A <see cref="T:GBase.Interfaces.DataHandling.IDataReader"/> that reads from a xml file
</summary>
<param name="path">The path to the xml file</param>
</member>
<member name="M:GBase.DataHandling.XmlDataReader.Init(System.Threading.CancellationToken)">
<summary>
Initialize the <see cref="T:GBase.DataHandling.XmlDataReader"/>
</summary>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken"/> to cancel the async operation</param>
<returns>Returns true if successful, false if not</returns>
<exception cref="T:System.Exception">No root element found</exception>
</member>
<member name="M:GBase.DataHandling.XmlDataReader.Read``2(System.String)">
<summary> <summary>
Read the data of a property Read the data of a property
</summary> </summary>
<typeparam name="T">The <see cref="T:System.Type"/></typeparam> <typeparam name="T">The <see cref="T:System.Type"/></typeparam>
<typeparam name="TProperty">The <see cref="T:System.Type"/> of the property</typeparam> <typeparam name="TProperty">The <see cref="T:System.Type"/> of the property</typeparam>
<param name="file"></param>
<param name="propertyName">The name of the property</param> <param name="propertyName">The name of the property</param>
<param name="cancellationToken"></param>
<returns>The data of the given property, null if no data found</returns> <returns>The data of the given property, null if no data found</returns>
<exception cref="T:System.ArgumentNullException"><paramref name="propertyName"/></exception> <exception cref="T:System.ArgumentNullException"><paramref name="propertyName"/></exception>
<exception cref="T:System.InvalidOperationException">Invalid <see cref="T:System.Type"/> found for the read object</exception> <exception cref="T:System.InvalidOperationException">Invalid <see cref="T:System.Type"/> found for the read object</exception>
</member> </member>
<member name="M:GBase.DataHandling.XmlDataReader.DisposeAsync">
<summary>
Dispose used resources asynchronously
</summary>
<returns>A <see cref="T:System.Threading.Tasks.ValueTask"/> to await</returns>
</member>
<member name="T:GBase.DataHandling.XmlDataWriter"> <member name="T:GBase.DataHandling.XmlDataWriter">
<summary> <summary>
A <see cref="T:GBase.Interfaces.DataHandling.IDataWriter"/> that writes to a xml file A <see cref="T:GBase.Interfaces.DataHandling.IDataWriter"/> that writes to a xml file
</summary> </summary>
</member> </member>
<member name="M:GBase.DataHandling.XmlDataWriter.#ctor(System.String,System.String)"> <member name="M:GBase.DataHandling.XmlDataWriter.InitFile(System.IO.FileStream,System.String,System.Threading.CancellationToken)">
<summary>
A <see cref="T:GBase.Interfaces.DataHandling.IDataWriter"/> that writes to an xml file
</summary>
<param name="path">The path to the xml file</param>
<param name="rootElementName">The root element name of the xml file</param>
</member>
<member name="M:GBase.DataHandling.XmlDataWriter.Init(System.Threading.CancellationToken)">
<summary> <summary>
Initialize the <see cref="T:GBase.DataHandling.XmlDataWriter"/> Initialize the <see cref="T:GBase.DataHandling.XmlDataWriter"/>
</summary> </summary>
<param name="file"></param>
<param name="rootElementName"></param>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken"/> to cancel the async operation</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken"/> to cancel the async operation</param>
<returns>Returns true if successful, false if not</returns> <returns>Returns true if successful, false if not</returns>
<exception cref="T:System.Exception">No root element found</exception> <exception cref="T:System.Exception">No root element found</exception>
</member> </member>
<member name="M:GBase.DataHandling.XmlDataWriter.Write``2(System.String,System.String,System.Boolean)"> <member name="M:GBase.DataHandling.XmlDataWriter.Write``2(System.IO.FileStream,System.String,System.String,System.Boolean,System.Threading.CancellationToken)">
<summary> <summary>
Write the data of a property Write the data of a property
</summary> </summary>
<typeparam name="T">The <see cref="T:System.Type"/> that implements the property</typeparam> <typeparam name="T">The <see cref="T:System.Type"/></typeparam>
<typeparam name="TProperty">The <see cref="T:System.Type"/> of the property</typeparam> <typeparam name="TProperty">The <see cref="T:System.Type"/> of the property</typeparam>
<param name="file"></param>
<param name="propertyName">The name of the property</param> <param name="propertyName">The name of the property</param>
<param name="value">The value of the property</param> <param name="value">The value of the property</param>
<param name="overwrite">If true an existing value is overwritten, if false an additional value is added</param> <param name="overwrite">If true an existing value is overwritten, if false an additional value is added</param>
<param name="cancellationToken"></param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> to await</returns>
</member>
<member name="M:GBase.DataHandling.XmlDataWriter.Write``1(System.IO.FileStream,System.String,System.String,System.Type,System.Boolean,System.Threading.CancellationToken)">
<summary>
Write the data of a property
</summary>
<typeparam name="T">The <see cref="T:System.Type"/> that implements the property</typeparam>
<param name="file"></param>
<param name="propertyName">The name of the property</param>
<param name="value">The value of the property</param>
<param name="propertyType"></param>
<param name="overwrite">If true an existing value is overwritten, if false an additional value is added</param>
<param name="cancellationToken"></param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> to await</returns> <returns>A <see cref="T:System.Threading.Tasks.Task"/> to await</returns>
<exception cref="T:System.ArgumentNullException"><paramref name="propertyName"/></exception> <exception cref="T:System.ArgumentNullException"><paramref name="propertyName"/></exception>
<exception cref="T:GBase.DataHandling.Exceptions.InvalidXmlFileException">No root element is set</exception>
</member> </member>
<member name="M:GBase.DataHandling.XmlDataWriter.Remove``2(System.String,System.String)"> <member name="M:GBase.DataHandling.XmlDataWriter.Remove``2(System.IO.FileStream,System.String,System.String,System.Threading.CancellationToken)">
<summary> <summary>
Remove the value for the given property Remove the value for the given property
</summary> </summary>
<typeparam name="T">The <see cref="T:System.Type"/> of the property</typeparam> <typeparam name="T">The <see cref="T:System.Type"/> of the property</typeparam>
<typeparam name="TProperty">The <see cref="T:System.Type"/> of the property</typeparam> <typeparam name="TProperty">The <see cref="T:System.Type"/> of the property</typeparam>
<param name="file"></param>
<param name="propertyName">The name of the property</param> <param name="propertyName">The name of the property</param>
<param name="value">The value to set</param> <param name="value">The value to set</param>
<param name="cancellationToken"></param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> to await</returns> <returns>A <see cref="T:System.Threading.Tasks.Task"/> to await</returns>
<exception cref="T:System.ArgumentNullException"><paramref name="propertyName"/></exception> <exception cref="T:System.ArgumentNullException"><paramref name="propertyName"/></exception>
</member> <exception cref="T:GBase.DataHandling.Exceptions.InvalidXmlFileException">No root element is set</exception>
<member name="M:GBase.DataHandling.XmlDataWriter.DisposeAsync">
<summary>
Dispose used resources asynchronously
</summary>
<returns>A <see cref="T:System.Threading.Tasks.ValueTask"/> to await</returns>
</member> </member>
<member name="T:GBase.Exceptions.InterfaceEnumerablePassedException"> <member name="T:GBase.Exceptions.InterfaceEnumerablePassedException">
<summary> <summary>
@ -372,19 +361,14 @@
</summary> </summary>
<param name="type">The table type</param> <param name="type">The table type</param>
</member> </member>
<member name="T:GBase.Exceptions.MissingTableException"> <member name="T:GBase.Exceptions.MissingTableException`1">
<summary> <summary>
<see cref="T:System.Exception"/> that the table for the given <see cref="P:GBase.Exceptions.MissingTableException.Type"/> is missing <see cref="T:System.Exception"/> that the table for the given <see cref="T:System.Type"/> is missing
</summary> </summary>
</member> </member>
<member name="M:GBase.Exceptions.MissingTableException.#ctor(System.Type)"> <member name="M:GBase.Exceptions.MissingTableException`1.#ctor">
<summary> <summary>
<see cref="T:System.Exception"/> that the table for the given <see cref="P:GBase.Exceptions.MissingTableException.Type"/> is missing <see cref="T:System.Exception"/> that the table for the given <see cref="T:System.Type"/> is missing
</summary>
</member>
<member name="P:GBase.Exceptions.MissingTableException.Type">
<summary>
The <see cref="P:GBase.Exceptions.MissingTableException.Type"/> that has no table
</summary> </summary>
</member> </member>
<member name="T:GBase.Factories.GBaseTableFactory"> <member name="T:GBase.Factories.GBaseTableFactory">
@ -410,7 +394,7 @@
Factory for the <see cref="T:GBase.Interfaces.IGBaseColumn"/> Factory for the <see cref="T:GBase.Interfaces.IGBaseColumn"/>
</summary> </summary>
</member> </member>
<member name="M:GBase.Factories.IGBaseColumnFactory.Create"> <member name="M:GBase.Factories.IGBaseColumnFactory.Create(System.String)">
<summary> <summary>
Creates an <see cref="T:GBase.Interfaces.IGBaseColumn"/> Creates an <see cref="T:GBase.Interfaces.IGBaseColumn"/>
</summary> </summary>
@ -460,11 +444,10 @@
The file extension for all GBase tables The file extension for all GBase tables
</summary> </summary>
</member> </member>
<member name="M:GBase.FileHandling.FileHandler.#ctor(GBase.Interfaces.DataHandling.Pool.IDataHandlerPool)"> <member name="M:GBase.FileHandling.FileHandler.#ctor">
<summary> <summary>
Internal file handler Internal file handler
</summary> </summary>
<param name="dataHandlerPool">The <see cref="T:GBase.Interfaces.DataHandling.Pool.IDataHandlerPool"/></param>
</member> </member>
<member name="M:GBase.FileHandling.FileHandler.Init(System.String,System.Threading.CancellationToken)"> <member name="M:GBase.FileHandling.FileHandler.Init(System.String,System.Threading.CancellationToken)">
<summary> <summary>
@ -474,48 +457,6 @@
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken"/> to cancel the asynchronous operation</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken"/> to cancel the asynchronous operation</param>
<returns>True if successful, false if not</returns> <returns>True if successful, false if not</returns>
</member> </member>
<member name="M:GBase.FileHandling.FileHandler.SetValue``2(System.String,``1,System.Threading.CancellationToken)">
<summary>
Set the value for the given property
</summary>
<typeparam name="T">The <see cref="T:System.Type"/> of the property</typeparam>
<typeparam name="TProperty">The <see cref="T:System.Type"/> of the property</typeparam>
<param name="propertyName">The name of the property</param>
<param name="value">The value to set</param>
<param name="cancellationToken"></param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> to await</returns>
</member>
<member name="M:GBase.FileHandling.FileHandler.RemoveValue``2(System.String,``1,System.Threading.CancellationToken)">
<summary>
Remove the value for the given property
</summary>
<typeparam name="T">The <see cref="T:System.Type"/> of the property</typeparam>
<typeparam name="TProperty">The <see cref="T:System.Type"/> of the property</typeparam>
<param name="propertyName">The name of the property</param>
<param name="value">The value to set</param>
<param name="cancellationToken"></param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> to await</returns>
</member>
<member name="M:GBase.FileHandling.FileHandler.GetValue``2(System.String,System.Threading.CancellationToken)">
<summary>
Get the value for the given property, if multiple values are set the first is returned
</summary>
<typeparam name="T">The <see cref="T:System.Type"/> of the property</typeparam>
<typeparam name="TProperty">The <see cref="T:System.Type"/> of the property</typeparam>
<param name="propertyName">The name of the property</param>
<param name="cancellationToken"></param>
<returns>The value for the given property</returns>
</member>
<member name="M:GBase.FileHandling.FileHandler.GetValues``2(System.String,System.Threading.CancellationToken)">
<summary>
Get all the values that are set for the given property
</summary>
<typeparam name="T">The <see cref="T:System.Type"/> of the property</typeparam>
<typeparam name="TProperty">The <see cref="T:System.Type"/> of the property</typeparam>
<param name="propertyName">The name of the property</param>
<param name="cancellationToken"></param>
<returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> with all the values for the property</returns>
</member>
<member name="M:GBase.FileHandling.FileHandler.DisposeAsync"> <member name="M:GBase.FileHandling.FileHandler.DisposeAsync">
<summary> <summary>
Dispose used resources asynchronously Dispose used resources asynchronously
@ -583,7 +524,7 @@
A column of a <see cref="T:GBase.Interfaces.IGBaseTable"/> A column of a <see cref="T:GBase.Interfaces.IGBaseTable"/>
</summary> </summary>
</member> </member>
<member name="M:GBase.GBaseColumn.#ctor"> <member name="M:GBase.GBaseColumn.#ctor(System.String)">
<summary> <summary>
A column of a <see cref="T:GBase.Interfaces.IGBaseTable"/> A column of a <see cref="T:GBase.Interfaces.IGBaseTable"/>
</summary> </summary>
@ -603,7 +544,7 @@
<summary> <summary>
GBase object that allows conversion from <see cref="T:System.String"/> GBase object that allows conversion from <see cref="T:System.String"/>
</summary> </summary>
<exception cref="T:GBase.Exceptions.MissingTableException">No table for <typeparamref name="T"/> is existing</exception> <exception cref="T:GBase.Exceptions.MissingTableException`1">No table for <typeparamref name="T"/> is existing</exception>
</member> </member>
<member name="M:GBase.GBaseObject`1.InitializeFromString(System.String)"> <member name="M:GBase.GBaseObject`1.InitializeFromString(System.String)">
<summary> <summary>
@ -616,10 +557,13 @@
A <see cref="T:GBase.Interfaces.IGBase"/> table A <see cref="T:GBase.Interfaces.IGBase"/> table
</summary> </summary>
</member> </member>
<member name="M:GBase.GBaseTable`1.#ctor(GBase.FileHandling.Factories.IFileHandlerFactory,GBase.Factories.IGBaseColumnFactory)"> <member name="M:GBase.GBaseTable`1.#ctor(GBase.FileHandling.Factories.IFileHandlerFactory,GBase.Interfaces.DataHandling.Pool.IDataHandlerPool,GBase.Factories.IGBaseColumnFactory)">
<summary> <summary>
A <see cref="T:GBase.Interfaces.IGBase"/> table A <see cref="T:GBase.Interfaces.IGBase"/> table
</summary> </summary>
<param name="fileHandlerFactory"></param>
<param name="dataHandlerPool">The <see cref="T:GBase.Interfaces.DataHandling.Pool.IDataHandlerPool"/></param>
<param name="gBaseColumnFactory"></param>
</member> </member>
<member name="P:GBase.GBaseTable`1.Type"> <member name="P:GBase.GBaseTable`1.Type">
<summary> <summary>
@ -680,22 +624,6 @@
<param name="entry">The entry implementing <see cref="T:GBase.Api.INotifyGBaseEntryChanged"/></param> <param name="entry">The entry implementing <see cref="T:GBase.Api.INotifyGBaseEntryChanged"/></param>
<returns>True if successful, false if not</returns> <returns>True if successful, false if not</returns>
</member> </member>
<member name="M:GBase.GBaseTable`1.ModifyEntry(System.Object,System.String,System.Object)">
<summary>
Modify the property of a given entry with the given value
</summary>
<param name="entry">The entry</param>
<param name="propertyName">The name of the property</param>
<param name="value">The new value to set</param>
<returns>True if successful, false if not</returns>
</member>
<member name="M:GBase.GBaseTable`1.OnGBaseEntryChanged(System.Object,GBase.Api.GBaseEntryChangedEventArgs)">
<summary>
A <see cref="T:GBase.Interfaces.IGBase"/> entry changed
</summary>
<param name="entry">The entry (sender)</param>
<param name="args">The <see cref="T:GBase.Api.GBaseEntryChangedEventArgs"/></param>
</member>
<member name="M:GBase.GBaseTable`1.DisposeAsync"> <member name="M:GBase.GBaseTable`1.DisposeAsync">
<summary> <summary>
The <see cref="M:System.IAsyncDisposable.DisposeAsync"/> method The <see cref="M:System.IAsyncDisposable.DisposeAsync"/> method
@ -768,13 +696,15 @@
<param name="value">The value to set</param> <param name="value">The value to set</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> to await</returns> <returns>A <see cref="T:System.Threading.Tasks.Task"/> to await</returns>
</member> </member>
<member name="M:GBase.Interfaces.DataHandling.Cache.IDataHandlerCache.TryGetValues``2(System.String)"> <member name="M:GBase.Interfaces.DataHandling.Cache.IDataHandlerCache.TryGetValues``2(System.IO.FileStream,System.String,System.Threading.CancellationToken)">
<summary> <summary>
Try to get values from the cache for the given property Try to get values from the cache for the given property
</summary> </summary>
<typeparam name="T">The <see cref="T:System.Type"/> that implements the property</typeparam> <typeparam name="T">The <see cref="T:System.Type"/> that implements the property</typeparam>
<typeparam name="TProperty">The <see cref="T:System.Type"/> of the property</typeparam> <typeparam name="TProperty">The <see cref="T:System.Type"/> of the property</typeparam>
<param name="file"></param>
<param name="propertyName">The name of the property</param> <param name="propertyName">The name of the property</param>
<param name="cancellationToken"></param>
<returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> with all the values for the property</returns> <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> with all the values for the property</returns>
</member> </member>
<member name="T:GBase.Interfaces.DataHandling.Cache.IDataHandlerCacheEntry"> <member name="T:GBase.Interfaces.DataHandling.Cache.IDataHandlerCacheEntry">
@ -817,50 +747,57 @@
Interface for data handlers to implement Interface for data handlers to implement
</summary> </summary>
</member> </member>
<member name="M:GBase.Interfaces.DataHandling.IDataHandler.Init(System.Boolean,System.Threading.CancellationToken)"> <member name="M:GBase.Interfaces.DataHandling.IDataHandler.Init(System.Boolean)">
<summary> <summary>
Initialize the <see cref="T:GBase.Interfaces.DataHandling.IDataHandler"/> Initialize the <see cref="T:GBase.Interfaces.DataHandling.IDataHandler"/>
</summary> </summary>
<param name="overwrite">If true an existing value is overwritten, if false an additional value is added</param> <param name="overwrite">If true an existing value is overwritten, if false an additional value is added</param>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken"/> to cancel the async operation</param>
<returns>Returns true if successful, false if not</returns> <returns>Returns true if successful, false if not</returns>
</member> </member>
<member name="M:GBase.Interfaces.DataHandling.IDataHandler.SetValue``2(System.String,``1)"> <member name="M:GBase.Interfaces.DataHandling.IDataHandler.SetValue``2(System.IO.FileStream,System.String,``1,System.Threading.CancellationToken)">
<summary> <summary>
Set the value for the given property Set the value for the given property
</summary> </summary>
<typeparam name="T">The <see cref="T:System.Type"/> of the property</typeparam> <typeparam name="T">The <see cref="T:System.Type"/> of the property</typeparam>
<typeparam name="TProperty">The <see cref="T:System.Type"/> of the property</typeparam> <typeparam name="TProperty">The <see cref="T:System.Type"/> of the property</typeparam>
<param name="entryFile"></param>
<param name="propertyName">The name of the property</param> <param name="propertyName">The name of the property</param>
<param name="value">The value to set</param> <param name="value">The value to set</param>
<param name="cancellationToken"></param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> to await</returns> <returns>A <see cref="T:System.Threading.Tasks.Task"/> to await</returns>
</member> </member>
<member name="M:GBase.Interfaces.DataHandling.IDataHandler.RemoveValue``2(System.String,``1)"> <member name="M:GBase.Interfaces.DataHandling.IDataHandler.RemoveValue``2(System.IO.FileStream,System.String,``1,System.Threading.CancellationToken)">
<summary> <summary>
Remove the value for the given property Remove the value for the given property
</summary> </summary>
<typeparam name="T">The <see cref="T:System.Type"/> of the property</typeparam> <typeparam name="T">The <see cref="T:System.Type"/> of the property</typeparam>
<typeparam name="TProperty">The <see cref="T:System.Type"/> of the property</typeparam> <typeparam name="TProperty">The <see cref="T:System.Type"/> of the property</typeparam>
<param name="entryFile"></param>
<param name="propertyName">The name of the property</param> <param name="propertyName">The name of the property</param>
<param name="value">The value to set</param> <param name="value">The value to set</param>
<param name="cancellationToken"></param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> to await</returns> <returns>A <see cref="T:System.Threading.Tasks.Task"/> to await</returns>
</member> </member>
<member name="M:GBase.Interfaces.DataHandling.IDataHandler.GetValue``2(System.String)"> <member name="M:GBase.Interfaces.DataHandling.IDataHandler.GetValue``2(System.IO.FileStream,System.String,System.Threading.CancellationToken)">
<summary> <summary>
Get the value for the given property, if multiple values are set the first is returned Get the value for the given property, if multiple values are set the first is returned
</summary> </summary>
<typeparam name="T">The <see cref="T:System.Type"/> of the property</typeparam> <typeparam name="T">The <see cref="T:System.Type"/> of the property</typeparam>
<typeparam name="TProperty">The <see cref="T:System.Type"/> of the property</typeparam> <typeparam name="TProperty">The <see cref="T:System.Type"/> of the property</typeparam>
<param name="file"></param>
<param name="propertyName">The name of the property</param> <param name="propertyName">The name of the property</param>
<param name="cancellationToken"></param>
<returns>The value for the given property</returns> <returns>The value for the given property</returns>
</member> </member>
<member name="M:GBase.Interfaces.DataHandling.IDataHandler.GetValues``2(System.String)"> <member name="M:GBase.Interfaces.DataHandling.IDataHandler.GetValues``2(System.IO.FileStream,System.String,System.Threading.CancellationToken)">
<summary> <summary>
Get all the values that are set for the given property Get all the values that are set for the given property
</summary> </summary>
<typeparam name="T">The <see cref="T:System.Type"/> of the property</typeparam> <typeparam name="T">The <see cref="T:System.Type"/> of the property</typeparam>
<typeparam name="TProperty">The <see cref="T:System.Type"/> of the property</typeparam> <typeparam name="TProperty">The <see cref="T:System.Type"/> of the property</typeparam>
<param name="file"></param>
<param name="propertyName">The name of the property</param> <param name="propertyName">The name of the property</param>
<param name="cancellationToken"></param>
<returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> with all the values for the property</returns> <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> with all the values for the property</returns>
</member> </member>
<member name="T:GBase.Interfaces.DataHandling.IDataReader"> <member name="T:GBase.Interfaces.DataHandling.IDataReader">
@ -868,20 +805,15 @@
Interface for data readers to implement Interface for data readers to implement
</summary> </summary>
</member> </member>
<member name="M:GBase.Interfaces.DataHandling.IDataReader.Init(System.Threading.CancellationToken)"> <member name="M:GBase.Interfaces.DataHandling.IDataReader.Read``2(System.IO.FileStream,System.String,System.Threading.CancellationToken)">
<summary>
Initialize the <see cref="T:GBase.Interfaces.DataHandling.IDataReader"/>
</summary>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken"/> to cancel the async operation</param>
<returns>Returns true if successful, false if not</returns>
</member>
<member name="M:GBase.Interfaces.DataHandling.IDataReader.Read``2(System.String)">
<summary> <summary>
Read the data of a property Read the data of a property
</summary> </summary>
<typeparam name="T">The <see cref="T:System.Type"/></typeparam> <typeparam name="T">The <see cref="T:System.Type"/></typeparam>
<typeparam name="TProperty">The <see cref="T:System.Type"/> of the property</typeparam> <typeparam name="TProperty">The <see cref="T:System.Type"/> of the property</typeparam>
<param name="file"></param>
<param name="propertyName">The name of the property</param> <param name="propertyName">The name of the property</param>
<param name="cancellationToken"></param>
<returns>The data of the given property, null if no data found</returns> <returns>The data of the given property, null if no data found</returns>
</member> </member>
<member name="T:GBase.Interfaces.DataHandling.IDataWriter"> <member name="T:GBase.Interfaces.DataHandling.IDataWriter">
@ -889,32 +821,51 @@
Interface for data writers to implement Interface for data writers to implement
</summary> </summary>
</member> </member>
<member name="M:GBase.Interfaces.DataHandling.IDataWriter.Init(System.Threading.CancellationToken)"> <member name="M:GBase.Interfaces.DataHandling.IDataWriter.InitFile(System.IO.FileStream,System.String,System.Threading.CancellationToken)">
<summary> <summary>
Initialize the <see cref="T:GBase.Interfaces.DataHandling.IDataWriter"/> Initialize the <see cref="T:GBase.Interfaces.DataHandling.IDataWriter"/>
</summary> </summary>
<param name="file"></param>
<param name="rootElementName"></param>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken"/> to cancel the async operation</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken"/> to cancel the async operation</param>
<returns>Returns true if successful, false if not</returns> <returns>Returns true if successful, false if not</returns>
</member> </member>
<member name="M:GBase.Interfaces.DataHandling.IDataWriter.Write``2(System.String,System.String,System.Boolean)"> <member name="M:GBase.Interfaces.DataHandling.IDataWriter.Write``2(System.IO.FileStream,System.String,System.String,System.Boolean,System.Threading.CancellationToken)">
<summary> <summary>
Write the data of a property Write the data of a property
</summary> </summary>
<typeparam name="T">The <see cref="T:System.Type"/></typeparam> <typeparam name="T">The <see cref="T:System.Type"/></typeparam>
<typeparam name="TProperty">The <see cref="T:System.Type"/> of the property</typeparam> <typeparam name="TProperty">The <see cref="T:System.Type"/> of the property</typeparam>
<param name="file"></param>
<param name="propertyName">The name of the property</param> <param name="propertyName">The name of the property</param>
<param name="value">The value of the property</param> <param name="value">The value of the property</param>
<param name="overwrite">If true an existing value is overwritten, if false an additional value is added</param> <param name="overwrite">If true an existing value is overwritten, if false an additional value is added</param>
<param name="cancellationToken"></param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> to await</returns> <returns>A <see cref="T:System.Threading.Tasks.Task"/> to await</returns>
</member> </member>
<member name="M:GBase.Interfaces.DataHandling.IDataWriter.Remove``2(System.String,System.String)"> <member name="M:GBase.Interfaces.DataHandling.IDataWriter.Write``1(System.IO.FileStream,System.String,System.String,System.Type,System.Boolean,System.Threading.CancellationToken)">
<summary>
Write the data of a property
</summary>
<typeparam name="T">The <see cref="T:System.Type"/></typeparam>
<param name="file"></param>
<param name="propertyName">The name of the property</param>
<param name="value">The value of the property</param>
<param name="propertyType"></param>
<param name="overwrite">If true an existing value is overwritten, if false an additional value is added</param>
<param name="cancellationToken"></param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> to await</returns>
</member>
<member name="M:GBase.Interfaces.DataHandling.IDataWriter.Remove``2(System.IO.FileStream,System.String,System.String,System.Threading.CancellationToken)">
<summary> <summary>
Remove the value for the given property Remove the value for the given property
</summary> </summary>
<typeparam name="T">The <see cref="T:System.Type"/> of the property</typeparam> <typeparam name="T">The <see cref="T:System.Type"/> of the property</typeparam>
<typeparam name="TProperty">The <see cref="T:System.Type"/> of the property</typeparam> <typeparam name="TProperty">The <see cref="T:System.Type"/> of the property</typeparam>
<param name="file"></param>
<param name="propertyName">The name of the property</param> <param name="propertyName">The name of the property</param>
<param name="value">The value to set</param> <param name="value">The value to set</param>
<param name="cancellationToken"></param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> to await</returns> <returns>A <see cref="T:System.Threading.Tasks.Task"/> to await</returns>
</member> </member>
<member name="T:GBase.Interfaces.DataHandling.Xml.Cache.IXmlDataHandlerCache"> <member name="T:GBase.Interfaces.DataHandling.Xml.Cache.IXmlDataHandlerCache">
@ -960,48 +911,6 @@
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken"/> to cancel the asynchronous operation</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken"/> to cancel the asynchronous operation</param>
<returns>True if successful, false if not</returns> <returns>True if successful, false if not</returns>
</member> </member>
<member name="M:GBase.Interfaces.FileHandling.IFileHandler.SetValue``2(System.String,``1,System.Threading.CancellationToken)">
<summary>
Set the value for the given property
</summary>
<typeparam name="T">The <see cref="T:System.Type"/> of the property</typeparam>
<typeparam name="TProperty">The <see cref="T:System.Type"/> of the property</typeparam>
<param name="propertyName">The name of the property</param>
<param name="value">The value to set</param>
<param name="cancellationToken"></param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> to await</returns>
</member>
<member name="M:GBase.Interfaces.FileHandling.IFileHandler.RemoveValue``2(System.String,``1,System.Threading.CancellationToken)">
<summary>
Remove the value for the given property
</summary>
<typeparam name="T">The <see cref="T:System.Type"/> of the property</typeparam>
<typeparam name="TProperty">The <see cref="T:System.Type"/> of the property</typeparam>
<param name="propertyName">The name of the property</param>
<param name="value">The value to set</param>
<param name="cancellationToken"></param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> to await</returns>
</member>
<member name="M:GBase.Interfaces.FileHandling.IFileHandler.GetValue``2(System.String,System.Threading.CancellationToken)">
<summary>
Get the value for the given property, if multiple values are set the first is returned
</summary>
<typeparam name="T">The <see cref="T:System.Type"/> of the property</typeparam>
<typeparam name="TProperty">The <see cref="T:System.Type"/> of the property</typeparam>
<param name="propertyName">The name of the property</param>
<param name="cancellationToken"></param>
<returns>The value for the given property</returns>
</member>
<member name="M:GBase.Interfaces.FileHandling.IFileHandler.GetValues``2(System.String,System.Threading.CancellationToken)">
<summary>
Get all the values that are set for the given property
</summary>
<typeparam name="T">The <see cref="T:System.Type"/> of the property</typeparam>
<typeparam name="TProperty">The <see cref="T:System.Type"/> of the property</typeparam>
<param name="propertyName">The name of the property</param>
<param name="cancellationToken"></param>
<returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> with all the values for the property</returns>
</member>
<member name="T:GBase.Interfaces.IGBase"> <member name="T:GBase.Interfaces.IGBase">
<summary> <summary>
The base class of the GBase database The base class of the GBase database

Loading…
Cancel
Save